Modbus - IO-16 Bricklet – Tinkerforge

- Getting Started
  - Primer
  - Tutorials
  - FAQ
- Hardware
  - Bricks
  - Bricklets
  - Master Extensions
  - Power Supplies
  - Accessories
  - Timeline
- Software
  - Brick Daemon (brickd)
  - Brick Viewer (brickv)
  - API Bindings
  - Firmwares and Plugins
  - Device Identifier
  - Source Code and Bug Tracking
  - Programming Interface
- Starter Kits
  - Weather Station
  - Hardware Hacking
  - Server Room Monitoring
  - Blinkenlights
  - Internet of Things
  - Camera Slider
- Embedded Boards
  - Raspberry Pi
- Specifications
  - Technical Data
  - TCP/IP Protocol
  - Modbus Protocol
    - Protocol
    - API
      - Bricks
      - Bricklets
        - Ambient Light Bricklet
        - Analog In Bricklet
        - Analog Out Bricklet
        - Barometer Bricklet
        - Color Bricklet
        - Current12 Bricklet
        - Current25 Bricklet
        - Distance IR Bricklet
        - Distance US Bricklet
        - Dual Button Bricklet
        - Dual Relay Bricklet
        - GPS Bricklet
        - Hall Effect Bricklet
        - Humidity Bricklet
        - Industrial Digital In 4 Bricklet
        - Industrial Digital Out 4 Bricklet
        - Industrial Dual 0-20mA Bricklet
        - Industrial Quad Relay Bricklet
        - IO-16 Bricklet
          - API
            - Basic Functions
            - Advanced Functions
            - Callback Configuration Functions
            - Callbacks
        - IO-4 Bricklet
        - Joystick Bricklet
        - LCD 16x2 Bricklet
        - LCD 20x4 Bricklet
        - LED Strip Bricklet
        - Line Bricklet
        - Linear Poti Bricklet
        - Moisture Bricklet
        - Motion Detector Bricklet
        - Multi Touch Bricklet
        - NFC/RFID Bricklet
        - Piezo Buzzer Bricklet
        - Piezo Speaker Bricklet
        - PTC Bricklet
        - Remote Switch Bricklet
        - Rotary Encoder Bricklet
        - Rotary Poti Bricklet
        - Segment Display 4x7 Bricklet
        - Solid State Relay Bricklet
        - Sound Intensity Bricklet
        - Temperature Bricklet
        - Temperature IR Bricklet
        - Tilt Bricklet
        - Voltage Bricklet
        - Voltage/Current Bricklet
  - Wireshark Dissector

# Modbus - IO-16 Bricklet

This is the description of the Modbus protocol for the IO-16 Bricklet. General information and technical specifications for the IO-16 Bricklet are summarized in its hardware description.

## API

A general description of the Modbus protocol structure can be found here.

### Basic Functions

`BrickletIO16.``set_port`

  Function ID: | 1

  Request:

  - port -- char
  - value_mask -- uint8

  Response: | no response

  Sets the output value (high or low) for a port ("a" or "b") with a bitmask (8bit). A 1 in the bitmask means high and a 0 in the bitmask means low.

  For example: The value 15 or 0b00001111 will turn the pins 0-3 high and the pins 4-7 low for the specified port.

  Note

  This function does nothing for pins that are configured as input. Pull-up resistors can be switched on with `set_port_configuration`.

`BrickletIO16.``get_port`

  Function ID: | 2

  Request:

  - port -- char

  Response:

  - value_mask -- uint8

  Returns a bitmask of the values that are currently measured on the specified port. This function works if the pin is configured to input as well as if it is configured to output.

`BrickletIO16.``set_port_configuration`

  Function ID: | 3

  Request:

  - port -- char
  - selection_mask -- uint8
  - direction -- char
  - value -- bool

  Response: | no response

  Configures the value and direction of a specified port. Possible directions are 'i' and 'o' for input and output.

  If the direction is configured as output, the value is either high or low (set as true or false).

  If the direction is configured as input, the value is either pull-up or default (set as true or false).

  For example:

  - ('a', 255, 'i', true) or ('a', 0b11111111, 'i', true) will set all pins of port A as input pull-up.
  - ('a', 128, 'i', false) or ('a', 0b10000000, 'i', false) will set pin 7 of port A as input default (floating if nothing is connected).
  - ('b', 3, 'o', false) or ('b', 0b00000011, 'o', false) will set pins 0 and 1 of port B as output low.
  - ('b', 4, 'o', true) or ('b', 0b00000100, 'o', true) will set pin 2 of port B as output high.

  The default configuration is input with pull-up.

`BrickletIO16.``get_port_configuration`

  Function ID: | 4

  Request:

  - port -- char

  Response:

  - direction_mask -- uint8
  - value_mask -- uint8

  Returns a direction bitmask and a value bitmask for the specified port. A 1 in the direction bitmask means input and a 0 in the bitmask means output.

  For example: A return value of (15, 51) or (0b00001111, 0b00110011) for direction and value means that:

  - pins 0 and 1 are configured as input pull-up,
  - pins 2 and 3 are configured as input default,
  - pins 4 and 5 are configured as output high
  - and pins 6 and 7 are configured as output low.

`BrickletIO16.``get_edge_count`

  Function ID: | 14

  Request:

  - pin -- uint8
  - reset_counter -- bool

  Response:

  - count -- uint32

  Returns the current value of the edge counter for the selected pin on port A. You can configure the edges that are counted with `set_edge_count_config`.

  If you set the reset counter to true, the count is set back to 0 directly after it is read.

  New in version 2.0.3 (Plugin).

### Advanced Functions

`BrickletIO16.``set_port_monoflop`

  Function ID: | 10

  Request:

  - port -- char
  - selection_mask -- uint8
  - value_mask -- uint8
  - time -- uint32

  Response: | no response

  Configures a monoflop of the pins specified by the second parameter as 8 bit long bitmask. The specified pins must be configured for output. Non-output pins will be ignored.

  The third parameter is a bitmask with the desired value of the specified output pins. A 1 in the bitmask means high and a 0 in the bitmask means low.

  The forth parameter indicates the time (in ms) that the pins should hold the value.

  If this function is called with the parameters ('a', 9, 1, 1500) or ('a', 0b00001001, 0b00000001, 1500): Pin 0 will get high and pin 3 will get low on port 'a'. In 1.5s pin 0 will get low and pin 3 will get high again.

  A monoflop can be used as a fail-safe mechanism. For example: Lets assume you have a RS485 bus and an IO-16 Bricklet connected to one of the slave stacks. You can now call this function every second, with a time parameter of two seconds and pin 0 set to high. Pin 0 will be high all the time. If now the RS485 connection is lost, then pin 0 will get low in at most two seconds.

`BrickletIO16.``get_port_monoflop`

  Function ID: | 11

  Request:

  - port -- char
  - pin -- uint8

  Response:

  - value -- uint8
  - time -- uint32
  - time_remaining -- uint32

  Returns (for the given pin) the current value and the time as set by `set_port_monoflop` as well as the remaining time until the value flips.

  If the timer is not running currently, the remaining time will be returned as 0.

`BrickletIO16.``set_selected_values`

  Function ID: | 13

  Request:

  - port -- char
  - selection_mask -- uint8
  - value_mask -- uint8

  Response: | no response

  Sets the output value (high or low) for a port ("a" or "b" with a bitmask, according to the selection mask. The bitmask is 8 bit long and a 1 in the bitmask means high and a 0 in the bitmask means low.

  For example: The parameters ('a', 192, 128) or ('a', 0b11000000, 0b10000000) will turn pin 7 high and pin 6 low on port A, pins 0-6 will remain untouched.

  Note

  This function does nothing for pins that are configured as input. Pull-up resistors can be switched on with `SetConfiguration()`.

`BrickletIO16.``set_edge_count_config`

  Function ID: | 15

  Request:

  - pin -- uint8
  - edge_type -- uint8
  - debounce -- uint8

  Response: | no response

  Configures the edge counter for the selected pin of port A. Pins 0 and 1 are available for edge counting.

  The edge type parameter configures if rising edges, falling edges or both are counted if the pin is configured for input. Possible edge types are:

  - 0 = rising (default)
  - 1 = falling
  - 2 = both

  The debounce time is given in ms.

  Configuring an edge counter resets its value to 0.

  If you don't know what any of this means, just leave it at default. The default configuration is very likely OK for you.

  Default values: 0 (edge type) and 100ms (debounce time)

  New in version 2.0.3 (Plugin).

`BrickletIO16.``get_edge_count_config`

  Function ID: | 16

  Request:

  - pin -- uint8

  Response:

  - edge_type -- uint8
  - debounce -- uint8

  Returns the edge type and debounce time for the selected pin of port A as set by `set_edge_count_config`.

  New in version 2.0.3 (Plugin).

`BrickletIO16.``get_identity`

  Function ID: | 255
  Request: | empty payload

  Response:

  - uid -- char[8]
  - connected_uid -- char[8]
  - position -- char
  - hardware_version -- uint8[3]
  - firmware_version -- uint8[3]
  - device_identifier -- uint16

  Returns the UID, the UID where the Bricklet is connected to, the position, the hardware and firmware version as well as the device identifier.

  The position can be 'a', 'b', 'c' or 'd'.

  The device identifier numbers can be found here.

### Callback Configuration Functions

`BrickletIO16.``set_debounce_period`

  Function ID: | 5

  Request:

  - debounce -- uint32

  Response: | no response

  Sets the debounce period of the `CALLBACK_INTERRUPT` callback in ms.

  For example: If you set this value to 100, you will get the interrupt maximal every 100ms. This is necessary if something that bounces is connected to the IO-16 Bricklet, such as a button.

  The default value is 100.

`BrickletIO16.``get_debounce_period`

  Function ID: | 6
  Request: | empty payload

  Response:

  - debounce -- uint32

  Returns the debounce period as set by `set_debounce_period`.

`BrickletIO16.``set_port_interrupt`

  Function ID: | 7

  Request:

  - port -- char
  - interrupt_mask -- uint8

  Response: | no response

  Sets the pins on which an interrupt is activated with a bitmask. Interrupts are triggered on changes of the voltage level of the pin, i.e. changes from high to low and low to high.

  For example: ('a', 129) or ('a', 0b10000001) will enable the interrupt for pins 0 and 7 of port a.

  The interrupt is delivered with the callback `CALLBACK_INTERRUPT`.

`BrickletIO16.``get_port_interrupt`

  Function ID: | 8

  Request:

  - port -- char

  Response:

  - interrupt_mask -- uint8

  Returns the interrupt bitmask for the specified port as set by `set_port_interrupt`.

### Callbacks

`BrickletIO16.``CALLBACK_INTERRUPT`

  Function ID: | 9

  Response:

  - port -- char
  - interrupt_mask -- uint8
  - value_mask -- uint8

  This callback is triggered whenever a change of the voltage level is detected on pins where the interrupt was activated with `set_port_interrupt`.

  The values are the port, a bitmask that specifies which interrupts occurred and the current value bitmask of the port.

  For example:

  - ('a', 1, 1) or ('a', 0b00000001, 0b00000001) means that on port A an interrupt on pin 0 occurred and currently pin 0 is high and pins 1-7 are low.
  - ('b', 129, 254) or ('b', 0b10000001, 0b11111110) means that on port B interrupts on pins 0 and 7 occurred and currently pin 0 is low and pins 1-7 are high.

`BrickletIO16.``CALLBACK_MONOFLOP_DONE`

  Function ID: | 12

  Response:

  - port -- char
  - selection_mask -- uint8
  - value_mask -- uint8

  This callback is triggered whenever a monoflop timer reaches 0. The response values contain the port, the involved pins and the current value of the pins (the value after the monoflop).

The content of this page is licensed under Creative Commons Attribution 3.0 Unported License.