From 9f0a3a5e2ad8b1b5707e1ceb99cccd42abdc5d0f Mon Sep 17 00:00:00 2001 From: Christian Franke Date: Tue, 3 Jan 2012 02:07:06 +0100 Subject: Add a very terse and incomplete README file --- README | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 README (limited to 'README') diff --git a/README b/README new file mode 100644 index 0000000..281c5d4 --- /dev/null +++ b/README @@ -0,0 +1,30 @@ +This software is intended to run on the moodlamp by +muccc. (http://wiki.muc.ccc.de/moodlamp) + +Currenty (and for the foreseeable future) it is very +concerning features. However, it will hopefully have +a better documented protocol and run more stable. + + +A more precise protocol description will follow at some +point, also, the protocol will probably change until +there is a real spec. + +Commands are line based and end with \r or \n or both. + +The only real command is 'iRRGGBB' - it sets the LED +to the given color immediately, where RR, GG and BB are +hex numbers between 00 and ff. + +Also, there is q. This turns on verbose mode. Right now, +this means, the moodlamp will echo what is entered +and acknowledge commands. In a future version, verbose +mode will probably be default and applications should +take care to turn it off if they generate bulk traffic. + +I know this could be much better, but I am not in the +mood to think about the right solution for this here +and now. + +If a command was not unerstood, a single question mark is +printed. -- cgit v1.2.1