Changeset 5962:1f27cef8dbfa in roaraudio


Ignore:
Timestamp:
01/18/14 14:29:45 (5 years ago)
Author:
phi
Branch:
default
Message:

added some docs about the inner structure of the packets

File:
1 edited

Legend:

Unmodified
Added
Removed
  • include/libroarlight/roardmx.h

    r5961 r5962  
    8383#define ROAR_ROARDMX_EVENT_FOGHEAT  0x0C /* Fog machine is heating up */ 
    8484 
     85// Data format on the wire: 
     86/* 
     87 * All packets consist of a header and a body. 
     88 * The header has the size of 3 Bytes: 
     89 * 0) version. Must be ROAR_ROARDMX_VERSION. 
     90 * 1) packet type and flags. 
     91 * 2) length of body in bytes. 
     92 * 
     93 * the type-flags byte consists of the packet type in the lower nibble and 
     94 * the flags in the upper nibble. 
     95 * 
     96 * the header is followd by a body of zero to 255 bytes length. 
     97 * the content of the body depends on the used type of packet. 
     98 * 
     99 * SSET: (simple set) Sets channels to values. 
     100 *  The body consists of {channel, value}-pairs. 
     101 *  every entry is 3 byte: hi byte of channel, low byte of channel, value. 
     102 * 
     103 * IPO1: not implemented. 
     104 * IPO4: not implemented. 
     105 * INC8S: not implemented. 
     106 * RANGESET: not implemented. 
     107 * EVENT: transmit simple yet abstract events. 
     108 * The body is an array of bytes. Each byte represents one event. 
     109 * Each event has the upper two bits set to the meta type of the event 
     110 * (beat, on, off, hold) and the lower 6 bits to the type of te event. 
     111 * 
     112 * CONTROL: not implemented. 
     113 */ 
     114 
    85115struct roar_roardmx_message { 
    86116 unsigned char version; 
Note: See TracChangeset for help on using the changeset viewer.