Skip to content

Latest commit

 

History

History
135 lines (108 loc) · 4.96 KB

uni.md

File metadata and controls

135 lines (108 loc) · 4.96 KB
Raw

MTB-UNI Module

This specification applies for module types listed below:

Code Module type
0x10 MTB-UNI v2 with ATmega328p with IR support
0x11 MTB-UNI v2 with ATmega328p without IR support
0x15 MTB-UNI v4.0 with ATmega128 (without blue LED)
0x16 MTB-UNI v4.2 with ATmega128 (with blue LED)

MTB-UNI module is most used MTBbus modules. It contains 16 digital inputs and 16 digital outputs. Any output is capable of S-COM protocol transmission as well as flickering.

Outputs state

State of each output is encoded in 1 byte:

  • 0b 1xxx xxxx: S-COM code. x's represent specific S-COM code (0-127).
  • 0b 0000 000x: digital outputs.
    • x=0 = open collector,
    • x=1 = output grounded.
  • 0b 0100 xxxx: flicker output. xxxx:
    • 1: 1 Hz
    • 2: 2 Hz
    • 3: 3 Hz
    • 4: 4 Hz
    • 5: 5 Hz
    • 6: 10 Hz
    • 7: 33 tick/min
    • 8: 66 tick/min

Configuration

Configuration consists of 24 bytes for module 0x15 & 0x16 (MTB-UNI v4) and 26 bytes for module 0x10 (MTB-UNI v2). First 24 bytes are same.

  1. 16 bytes of safe outputs state (outputs indexed in order 0 to 15).
  2. 8 bytes of input keep delay.
    • Byte 0: 0bBBBBAAAA. A = delay of input 0, B = delay of input 1.
    • Byte 1: delay of input 2, delay of input 3.
    • ... Each input has 16 values of input delay. 0=0.0s, 1=0.1s, 2=0.2s, ..., 15=1.5s.
  3. For MTB-UNI v2 only: 2 bytes encoding inputs on which IR sensors should be used.
    • Byte 24: IR active on inputs 0bFEDCBA98.
    • Byte 25: IR active on inputs 0b76543210.

When input goes to logical 0, it must remain in this state for input keep delay to consider the input as logical 0. Only after the time input changed event is reported to master board.

Module-specific commands

Master → slave:

  • Set Configuration: n.o. data bytes: 24. Whole configuration is sent.
  • Get Configuration: n.o. data bytes: 0.
  • Get Input: n.o. data bytes: 0.
  • Set Output: n.o. data bytes: variable.
    • State of all outputs is always sent.
    • Data byte 0: full state mask for outputs 0bFEDCBA98.
    • Data byte 1: full state mask for outputs 0b76543210.
    • Data byte 2: binary state of outputs 0bFEDCBA98.
    • Data byte 3: binary state of outputs 0b76543210.
    • Data byte 4–n: state of full-state outputs in order 0–F.
    • Examples (only data bytes are written):
      • Set output 1 as active, other as inactive: 0x00 0x00 0x00 0x02.
      • Set output 8 to S-COM code 0x0A, output 10 as flickering with period 2 Hz, output 15 as active, other as inactive: 0x05 0x00 0xF0 0x00 0x42 0x8A.
    • Bits in binary state output which are masked by full state mask can contain any value. This value is ignored.
  • Firmware Write Flash
    • Data byte 0: first byte flash address high.
    • Data byte 1: first byte flash address low.
    • Data byte 2–65: 64 bytes of memory data.
  • Module-specific command
    • Data byte 0 = 0x01 = set if module supports IR sensors.
      • Data byte 1: 0x00 = no, 0x01 = yes, 0xFF = autodetect.
      • This command is available for modules v2 only (code 0x01, 0x02).

Slave → master:

  • Module Configuration: n.o. data bytes: 24. Whole configuration is sent.
  • Input Changed: n.o. data bytes: 2. Full state of inputs is sent.
    • Data byte 0: inputs 0bFEDCBA98.
    • Data byte 1: inputs 0b76543210.
    • Order of inputs in byte: 0b76543210.
  • Input State: n.o. data bytes: 2. Full state of inputs is sent.
  • Output Set: n.o. data bytes: variable. Same data bytes as in message Set Output is sent.

Firmware upgrade

Data is sent in frames of 64 bytes.

  • Firmware Write Flash

    • Data byte 0: page address.
    • Data byte 1: offset in page.
    • Data byte 2–65: memory data.

  • Firmware Write Flash Status

    • Data byte 1: page address.
    • Data byte 2: offset in page.

For module type 0x10 (MTB-UNI v2 with ATmega328p), page size is 128 bytes. Thus, for single page write 2 Firmware Write Flash commands must be sent:

  1. 0x01 0x43 0xF1 0x00 0x00 [64 bytes of data]
  2. 0x01 0x43 0xF1 0x00 0x40 [64 bytes of data]

For module type 0x15& 0x16 (MTB-UNI v4 with ATmega128), page size is 256 bytes. Thus, for single page write 4 Firmware Write Flash commands must be sent:

  1. 0x01 0x43 0xF1 0x00 0x00 [64 bytes of data] [checksum]
  2. 0x01 0x43 0xF1 0x00 0x40 [64 bytes of data] [checksum]
  3. 0x01 0x43 0xF1 0x00 0x80 [64 bytes of data] [checksum]
  4. 0x01 0x43 0xF1 0x00 0xC0 [64 bytes of data] [checksum]

Upgrade is done page-based. Frames in page need to be received in-order. Page is written when last frame of page is received. It is impossible to write just part of the page. In case when part of the page is supposed to be written, rest of the page must be padded.

Diagnostic information

Module reports no errors.

Module reports common warnings only.