mirror of
https://github.com/s00500/SimpleExpressions
synced 2024-11-23 05:50:54 +00:00
Adding images to documentation
This commit is contained in:
parent
d5332ff1f3
commit
00439dab89
87
README.md
87
README.md
@ -1,9 +1,90 @@
|
||||
# SimpleExpressions: Make your robots cute and noisy
|
||||
|
||||
This library simply takes a 7 LED Circle module and a buzzer to do lots of funny things, see for yourself
|
||||
![image of a cute robot](https://raw.githubusercontent.com/s00500/SimpleExpressions/master/docs/greencheck.jpg)
|
||||
|
||||
The sound are taken from BQs Zowie. Currently the library only supports ESP32
|
||||
This library simply takes a 7 LED Circle module and a buzzer to do lots of funny things, see for yourself.
|
||||
The reason I made this was that I wanted to have a simple way to make combine mouths and sounds on this funny little Robots
|
||||
|
||||
You can buy these little ws2812 circles for a dollar or two at aliexpress and other china marketplaces and they are a really simple way to make some funny output. And a beeper or buzzer is available literally everywhere.
|
||||
|
||||
![The main parts](https://raw.githubusercontent.com/s00500/SimpleExpressions/master/docs/parts.png)
|
||||
|
||||
|
||||
### Dependencies
|
||||
|
||||
Internally the library uses the **Adafruit NeoPixel Library**, so make sure you have this one installed
|
||||
|
||||
### Install
|
||||
|
||||
The library can be installed **manually** (by unzipping and copying the files to the "libraries" directory) or using the **Arduino Library installer**, there is not to much to care about, just make sure the **Adafruit NeoPixel Library** is also installed.
|
||||
|
||||
### Supported Platforms
|
||||
|
||||
The sound are taken from BQs Zowie. The Library supports all Arduino boards (that are compatible with the NeoPixel Library) and also the ESP8266 and ESP32
|
||||
|
||||
### Functions
|
||||
|
||||
|
||||
|
||||
### Available mouth shapes
|
||||
|
||||
## single color shapes
|
||||
|
||||
- **zeros**
|
||||
- **happySmall**
|
||||
- **happyFull**
|
||||
- **sadSmall**
|
||||
- **sadFull**
|
||||
- **neutral**
|
||||
- **circle**
|
||||
- **center**
|
||||
- **hook**
|
||||
- **upsidedownhook**
|
||||
- **kooh**
|
||||
- **upsidedownkooh**
|
||||
- **cross**
|
||||
- **rect**
|
||||
- **leftarrow**
|
||||
- **rightarrow**
|
||||
- **lefthalf**
|
||||
- **righthalf**
|
||||
|
||||
## multi color shapes
|
||||
|
||||
- **colorCircle**
|
||||
|
||||
### Available SOUNDS
|
||||
|
||||
- **S_CONNECTION**
|
||||
- **S_DISCONNECTION**
|
||||
- **S_BUTTON_PUSHED**
|
||||
- **S_MODE1**
|
||||
- **S_MODE2**
|
||||
- **S_MODE3**
|
||||
- **S_SURPRISE**
|
||||
- **S_OHOOH**
|
||||
- **S_OHOOH2**
|
||||
- **S_CUDDLY**
|
||||
- **S_SLEEPING**
|
||||
- **S_HAPPY**
|
||||
- **S_SUPER_HAPPY**
|
||||
- **S_HAPPY_SHORT**
|
||||
- **S_SAD**
|
||||
- **S_CONFUSED**
|
||||
- **S_FART1**
|
||||
- **S_FART2**
|
||||
- **S_FART3**
|
||||
|
||||
- **PIRATES** The complete **PIRATES OF THE CARIBBEAN** theme (highly experimental, but funny =P)
|
||||
|
||||
### TODO
|
||||
|
||||
- Provide further documentation
|
||||
- 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
|
||||
- Currently I am happy with it, any Ideas? let me know
|
||||
|
||||
### Buy me a coffee ☕️
|
||||
|
||||
If you like the library and all my other projects maybe think about [buying me a coffee](https://paypal.me/lukasbachschwell/3).? I really like [coffee](https://paypal.me/lukasbachschwell/3). ☕️ 🙃
|
||||
|
||||
![another image of a cute robot](https://raw.githubusercontent.com/s00500/SimpleExpressions/master/docs/bluearrow.jpg)
|
||||
|
BIN
docs/bluearrow.jpg
Normal file
BIN
docs/bluearrow.jpg
Normal file
Binary file not shown.
After Width: | Height: | Size: 1.6 MiB |
BIN
docs/greencheck.jpg
Normal file
BIN
docs/greencheck.jpg
Normal file
Binary file not shown.
After Width: | Height: | Size: 1.6 MiB |
BIN
docs/parts.png
Normal file
BIN
docs/parts.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 578 KiB |
Loading…
Reference in New Issue
Block a user