MycroftAI / enclosure-mark1

Replacing the faceplate repo
Apache License 2.0
9 stars 8 forks source link

Documentation #87

Closed MatthewScholefield closed 7 years ago

MatthewScholefield commented 7 years ago

To auto generate the possible commands run this in the root directory: cat lib/*Processor/*Processor.cpp | grep -E "startsWith\(\"|Processor\(\"" | sed -e 's/^.*Processor("\([a-z]*\)").*$/\n=== \1 ===/gm' | sed -e 's/^.*"\(.*\)".*$/\1/gm'

Current output:

=== system ===
reset
mute
unmute
blink=
version

=== eyes ===
color=
level=
fill=
volume=
spin=
on
off
set
reset

=== test ===
begin

=== mouth ===
reset
faketalk
talk
listen
think
text=
icon
viseme=

=== weather ===
display=

Other notes to document:

eyes.color=

Hexadecimal color converted to decimal int. For example, pink (#FF00FF) would be 16711935 by converting FF00FF using this website.

For reference, hexadecimal colors are stored as #RRGGBB

MatthewScholefield commented 7 years ago

Didn't realize it's now documented in protocols.txt