mergcbus Wiki

Status: Beta

Brought to you by: apcherry, mike47j, whitecf

Accessory

Labels:

Accessory protocol

Long events have 16 bit node number followed by a 16 bit event.

Short events. Although the producer will send the complete 4 byte event number, the consumer will ignore the producer's node number bytes. This allows a many to many situation where producers like DCC handsets can activate the same accessories even though they will have unique node numbers. Clearly this limits the number of short events to 64K-1. For these short events, the full 4 byte event is still sent, both to keep the format the same and to allow identification of the producer when required.

Node numbers 0x0000 and 0xFFFF should not be used for node numbers, since either can be the value of un-initialized memory.

Event numbers should also not use 0x0000 and 0xFFFF, usually they start from 0x0001.

The same data structure can be used for both types of event, if short events are internally defined as having node number 0x0000.

4B Request Unique Id from node (RQUID)

Format: <4B><NNhigh><NNlow>

90 Accessory ON (ACON)

Format: <90><NN hi><NN lo><EN hi><EN lo>

<Dat1> is the high byte of the node number (MS WORD of the full event #) <Dat2> is the low byte of the node number (MS WORD of the full event #) <Dat3> is the high byte of the short event number <Dat4> is the low byte of the short event number

Indicates an ON event using the full event number of 4 bytes.

91 Accessory OFF (ACOF)

Format: <91><NN hi><NN lo><EN hi><EN lo>

Indicates an OFF event using the full event number of 4 bytes.

92 Accessory Request Event (AREQ)

Format: <92><NN hi><NN lo><EN hi><EN lo>

Indicates a request event using the full event number of 4 bytes. A request event is used to elicit a response from a consumer when it is required to know the state of the consumer without producing an ON or OFF event or to trigger an event from a combi node.

93 Accessory Response Event (ARSP)

Format: <93><NN hi><NN lo><EN hi><EN lo>

Indicates a response event using the full event number of 4 bytes. A response event is a reply to a request (AREQ) from a consumer (combi node) without producing an ON or OFF event. (see example below in note 2).

98 Accessory Short ON (ASON)

Format: <98><NN hi><NN lo><EN hi><EN lo>

Indicates an ON event using the short event number of 2 LS bytes.

99 Accessory Short OFF (ASOF)

Format: <99><NN hi><NN lo><EN hi><EN lo>

Indicates an OFF event using the short event number of 2 LS bytes.

9A Accessory Request Event (ASRQ)

Format: <9A><NN hi><NN lo><EN hi><EN lo>

Indicates a request event using the short event number of 2 LS bytes. A request event is used to elicit a response from a consumer when it is required to know the state of the consumer without producing an ON or OFF event or to trigger an event from a combi node.

B0 On Event with 1 data byte (ACON1)

Format: <B0><NNhigh><NNlow><EVhigh><EVlow><data>

Indicates an 'ON' event using the full event number of 4 bytes with one additional data byte.

B1 Off Event with 1 data byte (ACOF1)

Format: <B1><NNhigh><NNlow><EVhigh><EVlow><data>

Indicates an 'OFF' event using the full event number of 4 bytes with one additional data byte.

B2 Request Event with 1 data byte (ACON1)

Format: <B2><NNhigh><NNlow><EVhigh><EVlow><EV#>

Allows a device to read stored event variables from a node. EV# is the EV index. Reply is EVANS.

B3 Response Event with 1 data byte (ACON1)

Format: <B3><NNhigh><NNlow><EVhigh><EVlow><value index>

Indicates a ‘request’ event using the full event number of 4 bytes and a pointer to a set of ‘states’ in a module. A request event is used to elicit a response from a consumer when it is required to know the ‘state’ of the consumer without producing an ON or OFF event or to trigger an event from a ‘combi’ node.

B4 Accessory Response Event (ARSP1)

Format: <B4><NN hi><NN lo><EN hi><EN lo><data>

<data> is the value requested by a ARSQ1 request

Indicates a ‘response’ event using the full event number of 4 bytes. A response event is a reply to a request (AREQn) from a consumer (combi node) without producing an ON or OFF event.

D0 On Event with 2 data bytes (ACON2)

Format: <D0><NNhigh><NNlow><EVhigh><EVlow><data0><data1>

<Dat1> is the high byte of the node number (MS WORD of the full event #)
<Dat2> is the low byte of the node number (MS WORD of the full event #)
<Dat3> is the high byte of the short event number
<Dat4> is the low byte of the short event number
<Dat5> is an additional data Hi byte
<Dat6> is additional data Lo byte

Indicates an ON event using the full event number of 4 bytes with two additional data bytes

D1 Off Event with 2 data bytes (ACOF2)

Format: <D0><NNhigh><NNlow><EVhigh><EVlow><data0><data1>

<Dat1> is the high byte of the node number (MS WORD of the full event #)
<Dat2> is the low byte of the node number (MS WORD of the full event #)
<Dat3> is the high byte of the short event number
<Dat4> is the low byte of the short event number
<Dat5> is an additional data Hi byte
<Dat6> is additional data Lo byte

Indicates an OFF event using the full event number of 4 bytes with two additional data bytes

D4 Accessory Response Event (ARSP2)

Format: <D4><NN hi><NN lo><EN hi><EN lo><data1><data2>

Indicates a ‘response’ event using the full event number of 4 bytes and two additional data bytes. A response event is a reply to a request (AREQn) from a consumer (combi node) without producing an ON or OFF event. Not sure this is needed now if the AREQ1 seems to have an index and the reply will be in a ARSP1 packet.

E2 Unique ID reply (PUID)

Format: <E2><NNhigh><NNlow><UID1><UID2><UID3><UID4><UID5>

The reply to an ID request. May be a mistake ?

E3 RFID tag read (RFID)

Format: <E3><NNhigh><NNlow><RFID4><RFID3><RFID2><RFID1><RFID0>

The RFID read event, contains the RFID tag value (Big Endian).

EM4102 format readers return a 40 bit number when a tag is read. Although read only tags are usually quoted as being 64 bits, the unique tag number is only 40 bits, the other bits are used for the header and for row and column parity.

F0 On Event with 3 data bytes (ACON3)

Format: <F0><NNhigh><NNlow><EVhigh><EVlow><data0><data1><data2>

<Dat1> is the high byte of the node number (MS WORD of the full event #)
<Dat2> is the low byte of the node number (MS WORD of the full event #)
<Dat3> is the high byte of the short event number
<Dat4> is the low byte of the short event number
<Dat5> is an additional data byte 3
<Dat6> is additional data byte 2
<Dat7> is additional data byte 1

Indicates an ON event using the full event number of 4 bytes with three additional data bytes

F1 Off Event with 3 data bytes (ACOF3)

Format: <F1><NNhigh><NNlow><EVhigh><EVlow><data0><data1><data2>

<Dat1> is the high byte of the node number (MS WORD of the full event #)
<Dat2> is the low byte of the node number (MS WORD of the full event #)
<Dat3> is the high byte of the short event number
<Dat4> is the low byte of the short event number
<Dat5> is an additional data byte 3
<Dat6> is additional data byte 2
<Dat7> is additional data byte 1

Indicates an OFF event using the full event number of 4 bytes with three additional data bytes

F3 response event with 3 data (ARSP3)

Format: <F3><NNhigh><NNlow><EVhigh><EVlow><data0><data1><data2>

<Dat1> is the high byte of the node number (MS WORD of the full event #)
<Dat2> is the low byte of the node number (MS WORD of the full event #)
<Dat3> is the high byte of the short event number
<Dat4> is the low byte of the short event number
<Dat5> is an additional data byte 3
<Dat6> is additional data byte 2
<Dat7> is additional data byte 1

Indicates a response event using the full event number of 4 bytes and three additional data bytes. A response event is a reply to a request (AREQn) from a consumer (combi node) without producing an ON or OFF event.