-
-
Notifications
You must be signed in to change notification settings - Fork 136
eBUS background
This small tutorial is supposed to give you some background on the eBUS and the messages transmitted on it.
The eBUS protocol is byte oriented, which means that 8 bits of data are always transmitted in a row without means of interruption. As everything is based on RS232, there might be some start and stop bits on the wire as well, but these are not relevant for understanding the protocol.
The eBUS protocol defines 25 different master addresses, 203 pure slave addresses, a broadcast address, and some special values. Each master also has a dedicated slave address which can be found by simply adding 5 to the master address (wrapping at 256, i.e. 255+5 is 4).
Furthermore, there are two special values needed for synchronization and escaping. In total, this makes 256 different values (that's the point where your first "aha!" should be coming :-) ).
"Why exactly 25 masters?" you might think, and that is a very good question. The answer is pretty simple, because this magical number is directly associated with the arbitration.
"What?" - don't worry, it's just an evil technician word. Arbitration is like a small recipe that tells you what to do to make a good cake - or in the eBUS case: how to access the bus in order to send something on it without interrupting another party.
The receipe looks like that:
- wait for a SYNchronisation symbol to appear
- write your own master address
- read the next byte back from the bus
- if that byte is your own master address, you won!
- otherwise: start over again
In order to make that work, the master addresses are designed in a special way:
The two half bytes (upper and lower 4 bits) always have to contain a consecutive number of 1 bits starting from the lowest one, i.e. 0000, 0001, 0011, 0111, or 1111.
Now, when another master with a different address is sending it's own address at the same time, only the one with lesser number of 1 bits is going to win the arbitration process (because a 0 bit will lead to a lower voltage seen on the line) and continue sending the rest of it's message.
Consequently, master addresses with lesser number of 1 bits have a higher priority: Master address 0x00 has the highest priority and 0xff has the lowest.
The eBUS mainly has two different states: an idle state (when currently no message is sent), and an active state (when a message transfer is in progress).
In the idle state, a so called SYNchronisation symbol generator repeatedly sends a SYN symbol on the bus in a certain interval. This is necessary for all participants to know, when access to the bus is granted (see the previous chapter).
Once a master has successfully gathered access to the bus, it is supposed to immediately send the message. Consequently, a message starts with the master address which is immediately followed by the destination address. The destination can be one of the 25 master addresses, a slave address, or the broadcast address.
Depending on the destination address, the message structure is slightly different.
In the description of the individual message parts below, the following conventions are made:
- lowercase (and bold) stands for relevant data
- UPPERCASE indicates a constant or values that can be calculated from others
A broadcast message is sent to all devices on the bus and thus there is no direct answer to it. That's why this message is the easiest one. It consists of the following parts:
source_master BROADCAST primary secondary COUNT [data] CRC
The individual parts of the broadcast message are:
- source_master: the source master address
- BROADCAST: the destination address (the singular broadcast address)
- primary: the primary command
- secondary: the secondary command
- COUNT: the number of data bytes following
- data: COUNT data bytes
- CRC: the CRC of all previous bytes
A Master-Master message is sent from one master to another. It consists of the same parts as the broadcast message, but adds some further fields:
source_master destination_master primary secondary COUNT [data] CRC - ACK
The individual parts of the master-master message are:
- source_master: the source master address
- destination_master: the destination master address
- primary: the primary command
- secondary: the secondary command
- COUNT: the number of data bytes following
- data: COUNT data bytes
- CRC: the CRC of all previous bytes
- ACK: the acknowledge from the destination master
The Master-Slave message is the most complicated one, since the addressed slave device is supposed to send a response back on the bus after receiving the master part. It consists of the same parts as the master-master message, but again adds some further fields:
source_master destination_slave primary secondary COUNT [data] CRC - S_ACK S_COUNT [s_data] S_CRC - ACK
The individual parts of the master-slave message are:
- source_master: the source master address
- destination_slave: the destination slave address
- primary: the primary command
- secondary: the secondary command
- M_COUNT: the number of data bytes following
- m_data: M_COUNT data bytes
- M_CRC: the CRC of all previous bytes
- S_ACK: the acknowledge from the destination slave
- S_COUNT: the number of data bytes following (sent by the slave)
- s_data: S_COUNT data bytes (sent by the slave)
- S_CRC: the CRC of the slave bytes (sent by the slave)
- ACK: the acknowledge from the source master
Now when it comes to using the eBUS, the most important question is:
What is actually relevant data?
In the three message types described above, this is easy to recognize by looking at the lower case bold words.
Most of the messages seen on an eBUS environment are usually Master-Slave messages and thus, the relevant data transmitted by each message is this:
- source_master: the source master address
- destination_slave: the destination slave address
- primary: the primary command
- secondary: the secondary command
- m_data: master data bytes
- s_data: slave data bytes
The other two message types basically provide a sub set of these 6 data values.
This list of fields actually also tells you which data is most important (from top to bottom).
The structure of the data bytes of a message is distinguished either by the primary and secondary command alone, or sometimes also by one or both of the two addresses and/or further bytes part of the master data.
The eBUS specification already defines some messages and the structure of the data bytes by using distinct primary and secondary command bytes. Let's have a look at one of them, the identification message which can either be sent as Master-Slave message, or as Broadcast message:
Master-Slave identification message:
- source_master: the source master address
- destination_slave: the destination slave address
-
primary: the primary command
07 -
secondary: the secondary command
04 - m_data: master data bytes (empty)
- s_data: slave data bytes, supposed to look like this:
- 5*BYTE: device ID (ASCII)
- BCD: software version
- BCD: software revision
- BCD: hardware version
- BCD: hardware revision
Broadcast identification message:
- source_master: the source master address
-
primary: the primary command
07 -
secondary: the secondary command
04 - m_data: master data bytes, supposed to look like this:
- 5*BYTE: device ID (ASCII)
- BCD: software version
- BCD: software revision
- BCD: hardware version
- BCD: hardware revision
The Broadcast identification message might be seen from any master attached to the bus e.g. after powering up the bus.
As the primary and secondary command byte implicitly limit the number of possible messages to around 60000, each manufacturer may define it's own messages by using a designated primary command byte specific for each manufacturer.
Some manufacturers chose to include an additional command byte in the master data as to keep a two-byte message ID (i.e. composed of the secondary command and the first master data byte).