lbsadmin/SimpleExpressions
1
0
Fork 0
mirror of https://github.com/s00500/SimpleExpressions synced 2024-11-23 21:20:55 +00:00
Code Issues Releases Activity

Readme and keywords ready for initial release

Browse Source
This commit is contained in:
Lukas Bachschwell 2017-12-01 14:12:46 +01:00
parent b2e4d64847
commit 6acc2871a8
2 changed files with 36 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
README.md
View File

@ -24,11 +24,37 @@ The sound are taken from BQs Zowie. The Library supports all Arduino boards (tha
### Functions ### Functions
Just see the example how everything works together
- SimpleExpressions.**init(ledPin, buzzerPin);**
Initializes the library with the given pins
- SimpleExpressions.**clearMouth();**
Clears the mouth and sets all pixels off
- SimpleExpressions.**printMouth(mouthNumber, red, green, blue);**
Prints a mouth by its number and using the given color, useful to iterate through all of them (use **frameCount** or **colorFrameCount** to determine the maximum number)
(use without the colorvalues for multicolor mouths)
- SimpleExpressions.**writeMouth("cross", red, green, blue);**
Does basically the same but you can select the mouth by its name (use without the colorvalues for multicolor mouths)
- SimpleExpressions.**writeMouthGeneric(moutharray)**
**Advanced:** Write a mouth straight from your code with color values fo all of the pixels
- SimpleExpressions.**playSound(SOUND_NUMBER);**
Plays a sound by its number using the constants you can find below.
- SimpleExpressions.**_tone(noteFrequency, noteDuration, silentDuration);**
Similar to the arduino tone function, but also working on ESP32 (using ledc)
- SimpleExpressions.**bendTones(note1Frequency, note2Frequency, prop, noteDuration, ilentDuration);**
Similar to the arduino tone function, but also working on ESP32 (using ledc)
### Available mouth shapes ### Available mouth shapes
## single color shapes #### single color shapes
- **zeros** - **zeros**
- **happySmall** - **happySmall**
@ -49,7 +75,7 @@ The sound are taken from BQs Zowie. The Library supports all Arduino boards (tha
- **lefthalf** - **lefthalf**
- **righthalf** - **righthalf**
## multi color shapes #### multi color shapes
- **colorCircle** - **colorCircle**
@ -81,6 +107,7 @@ The sound are taken from BQs Zowie. The Library supports all Arduino boards (tha
- If you have new Ideas for different shapes or multicolor shapes just write them down and create a pull request (Or if you are not familiar with git draw them and post an issue) - If you have new Ideas for different shapes or multicolor shapes just write them down and create a pull request (Or if you are not familiar with git draw them and post an issue)
- Calculate frame count from arraysize - Calculate frame count from arraysize
- Example for **writeMouthGeneric()**
- Currently I am happy with it, any Ideas? let me know - Currently I am happy with it, any Ideas? let me know
### Buy me a coffee ☕️ ### Buy me a coffee ☕️

7
keywords.txt
View File

@ -12,10 +12,17 @@ SimpleExpressions KEYWORD1
# Methods and Functions (KEYWORD2) # Methods and Functions (KEYWORD2)
####################################### #######################################
clearMouth KEYWORD2
showMouth KEYWORD2 showMouth KEYWORD2
printMouth KEYWORD2 printMouth KEYWORD2
showColorMouth KEYWORD2
printColorMouth KEYWORD2
bendTones KEYWORD2
writeMouthGeneric KEYWORD2
playSound KEYWORD2 playSound KEYWORD2
_tone KEYWORD2 _tone KEYWORD2
bendTones KEYWORD2
####################################### #######################################
# Instances (KEYWORD2) # Instances (KEYWORD2)