BProtocol

BProtocol — definiton of the Blinkenlights Network Protocol

Synopsis




#define     MAGIC_MCU_SETUP
#define     MAGIC_MCU_FRAME
#define     MAGIC_MCU_DEVCTRL
#define     MAGIC_BLFRAME
#define     MAGIC_BLFRAME_256
#define     MAGIC_HEARTBEAT
#define     MCU_LISTENER_PORT
#define     MCU_ID_ANY
#define     MCU_DEVCTRL_OFF
#define     MCU_DEVCTRL_ON
#define     B_HEARTBEAT_PORT
#define     B_HEARTBEAT_INTERVAL

Description

The bprotocol.h header file defines the Blinkenlights Network Protocol. It contains structure definitions for the different network packets as well as defines for magic numbers.

This header file doesn't use any GLib types to make it possible to include it from applications that can not or don't want to use BLib. As a user of BLib you don't need to care about the details of the protocol described here. Use the BSender and BReceiver instead.

Details

MAGIC_MCU_SETUP

#define     MAGIC_MCU_SETUP

The magic number that identifies a setup packet.


MAGIC_MCU_FRAME

#define     MAGIC_MCU_FRAME

The magic number that identifies a frame packet.


MAGIC_MCU_DEVCTRL

#define     MAGIC_MCU_DEVCTRL

The magic number that identifies a device control packet.


MAGIC_BLFRAME

#define     MAGIC_BLFRAME

The magic number that identifies a frame packet in the old Blinkenlights protocol. BLib doesn't support this old version.


MAGIC_BLFRAME_256

#define     MAGIC_BLFRAME_256

The magic number that identifies a frame packet in an extension to the old Blinkenlights protocol. BLib doesn't support this old version.


MAGIC_HEARTBEAT

#define     MAGIC_HEARTBEAT

The magic number that identifies a heartbeat package as used with the BlinkenProxy protocol.


MCU_LISTENER_PORT

#define     MCU_LISTENER_PORT

The default port a matrox control unit listens too.


MCU_ID_ANY

#define     MCU_ID_ANY

Use this value in a setup packet to address all listening matrix control units.


MCU_DEVCTRL_OFF

#define     MCU_DEVCTRL_OFF

Use this value in a device control packet to switch a device off.


MCU_DEVCTRL_ON

#define     MCU_DEVCTRL_ON

Use this value in a device control packet to switch a device on.


B_HEARTBEAT_PORT

#define     B_HEARTBEAT_PORT

The default port number for BlinkenProxy heartbeat packets.


B_HEARTBEAT_INTERVAL

#define     B_HEARTBEAT_INTERVAL

The default timeout in milliseconds between BlinkenProxy heartbeat packets.

See Also

BPacket, BSender, BReceiver