MQTT - IO-16 Bricklet¶

Output¶

Download (example-output.txt)

1
2
3
4
5
6
7
8

# Change XYZ to the UID of your IO-16 Bricklet

setup:
    # Set pin 0 on port A to output low: 1 << 0 = 1
    publish '{"port": "a", "selection_mask": 1, "direction": "out", "value": false}' to tinkerforge/request/io16_bricklet/XYZ/set_port_configuration

    # Set pin 0 and 7 on port B to output high: (1 << 0) | (1 << 7) = 129
    publish '{"port": "b", "selection_mask": 129, "direction": "out", "value": true}' to tinkerforge/request/io16_bricklet/XYZ/set_port_configuration

Interrupt¶

Download (example-interrupt.txt)

1
2
3
4
5
6
7
8
9

# Change XYZ to the UID of your IO-16 Bricklet

setup:
    # Handle incoming interrupt callbacks
    subscribe to tinkerforge/callback/io16_bricklet/XYZ/interrupt
    publish '{"register": true}' to tinkerforge/register/io16_bricklet/XYZ/interrupt # Register interrupt callback

    # Enable interrupt on pin 2 of port A: 1 << 2 = 4
    publish '{"port": "a", "interrupt_mask": 4}' to tinkerforge/request/io16_bricklet/XYZ/set_port_interrupt

Input¶

Download (example-input.txt)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

# Change XYZ to the UID of your IO-16 Bricklet

setup:
    # Get current value from port A as bitmask
    subscribe to tinkerforge/response/io16_bricklet/XYZ/get_port
    publish '{"port": "a"}' to tinkerforge/request/io16_bricklet/XYZ/get_port

    # Get current value from port B as bitmask
    subscribe to tinkerforge/response/io16_bricklet/XYZ/get_port
    publish '{"port": "b"}' to tinkerforge/request/io16_bricklet/XYZ/get_port

Basic Functions¶

request/io16_bricklet/<UID>/set_port¶

Request:	port – Type: char, Range: ["a" to "b"] value_mask – Type: int, Range: [0 to 255]
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.

All running monoflop timers of the given port will be aborted if this function is called.

Note

This function does nothing for pins that are configured as input. Pull-up resistors can be switched on with request/io16_bricklet/<UID>/set_port_configuration.

request/io16_bricklet/<UID>/get_port¶

Request:	port – Type: char, Range: ["a" to "b"]
Response:	value_mask – Type: int, Range: [0 to 255]

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.

request/io16_bricklet/<UID>/set_port_configuration¶

Request:	port – Type: char, Range: ["a" to "b"] selection_mask – Type: int, Range: [0 to 255] direction – Type: char, Range: See symbols, Default: "i" value – Type: bool, Default: true
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.

Running monoflop timers for the selected pins will be aborted if this function is called.

The following symbols are available for this function:

For direction:

• "in" = "i"
• "out" = "o"

request/io16_bricklet/<UID>/get_port_configuration¶

Request:	port – Type: char, Range: ["a" to "b"]
Response:	direction_mask – Type: int, Range: [0 to 255] value_mask – Type: int, Range: [0 to 255]

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.

request/io16_bricklet/<UID>/get_edge_count¶

Request:	pin – Type: int, Range: [0 to 1] reset_counter – Type: bool
Response:	count – Type: int, Range: [0 to 232 - 1]

Returns the current value of the edge counter for the selected pin on port A. You can configure the edges that are counted with request/io16_bricklet/<UID>/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¶

request/io16_bricklet/<UID>/set_port_monoflop¶

Request:	port – Type: char, Range: ["a" to "b"] selection_mask – Type: int, Range: [0 to 255] value_mask – Type: int, Range: [0 to 255] time – Type: int, Unit: 1 ms, Range: [0 to 232 - 1]
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 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.

request/io16_bricklet/<UID>/get_port_monoflop¶

Request:	port – Type: char, Range: ["a" to "b"] pin – Type: int, Range: [0 to 7]
Response:	value – Type: int, Range: [0 to 255] time – Type: int, Unit: 1 ms, Range: [0 to 232 - 1] time_remaining – Type: int, Unit: 1 ms, Range: [0 to 232 - 1]

Returns (for the given pin) the current value and the time as set by request/io16_bricklet/<UID>/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.

request/io16_bricklet/<UID>/set_selected_values¶

Request:	port – Type: char, Range: ["a" to "b"] selection_mask – Type: int, Range: [0 to 255] value_mask – Type: int, Range: [0 to 255]
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.

Running monoflop timers for the selected pins will be aborted if this function is called.

Note

This function does nothing for pins that are configured as input. Pull-up resistors can be switched on with request/io16_bricklet/<UID>/set_port_configuration.

request/io16_bricklet/<UID>/set_edge_count_config¶

Request:	pin – Type: int, Range: [0 to 1] edge_type – Type: int, Range: See symbols, Default: 0 debounce – Type: int, Unit: 1 ms, Range: [0 to 255], Default: 100
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
• 1 = falling
• 2 = both

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.

The following symbols are available for this function:

For edge_type:

• "rising" = 0
• "falling" = 1
• "both" = 2

New in version 2.0.3 (Plugin).

request/io16_bricklet/<UID>/get_edge_count_config¶

Request:	pin – Type: int, Range: [0 to 1]
Response:	edge_type – Type: int, Range: See symbols, Default: 0 debounce – Type: int, Unit: 1 ms, Range: [0 to 255], Default: 100

Returns the edge type and debounce time for the selected pin of port A as set by request/io16_bricklet/<UID>/set_edge_count_config.

The following symbols are available for this function:

For edge_type:

• "rising" = 0
• "falling" = 1
• "both" = 2

New in version 2.0.3 (Plugin).

request/io16_bricklet/<UID>/get_identity¶

Request:

empty payload

Response:

uid – Type: string, Length: up to 8 connected_uid – Type: string, Length: up to 8 position – Type: char, Range: ["a" to "h", "z"] hardware_version – Type: [int, ...], Length: 3 0: major – Type: int, Range: [0 to 255] 1: minor – Type: int, Range: [0 to 255] 2: revision – Type: int, Range: [0 to 255] firmware_version – Type: [int, ...], Length: 3 0: major – Type: int, Range: [0 to 255] 1: minor – Type: int, Range: [0 to 255] 2: revision – Type: int, Range: [0 to 255] device_identifier – Type: int, Range: [0 to 216 - 1] _display_name – Type: string

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', 'd', 'e', 'f', 'g' or 'h' (Bricklet Port). A Bricklet connected to an Isolator Bricklet is always at position 'z'.

The device identifier numbers can be found here. If symbolic output is not disabled, the device identifier is mapped to the corresponding name in the format used in topics.

The display name contains the IO-16's name in a human readable form.

Callback Configuration Functions¶

request/io16_bricklet/<UID>/set_debounce_period¶

Request:	debounce – Type: int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 100
Response:	no response

Sets the debounce period of the register/io16_bricklet/<UID>/interrupt callback.

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.

request/io16_bricklet/<UID>/get_debounce_period¶

Request:	empty payload
Response:	debounce – Type: int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 100

Returns the debounce period as set by request/io16_bricklet/<UID>/set_debounce_period.

request/io16_bricklet/<UID>/set_port_interrupt¶

Request:	port – Type: char, Range: ["a" to "b"] interrupt_mask – Type: int, Range: [0 to 255]
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 register/io16_bricklet/<UID>/interrupt callback.

request/io16_bricklet/<UID>/get_port_interrupt¶

Request:	port – Type: char, Range: ["a" to "b"]
Response:	interrupt_mask – Type: int, Range: [0 to 255]

Returns the interrupt bitmask for the specified port as set by request/io16_bricklet/<UID>/set_port_interrupt.

Callbacks¶

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done with the corresponding .../register/... topic and an optional suffix. This suffix can be used to deregister the callback later.

register/io16_bricklet/<UID>/interrupt¶

Register Request:	register – Type: bool
Callback Response:	port – Type: char, Range: ["a" to "b"] interrupt_mask – Type: int, Range: [0 to 255] value_mask – Type: int, Range: [0 to 255]

A callback can be registered for this event by publishing to the .../register/io16_bricklet/<UID>/interrupt[/<SUFFIX>] topic with the payload "true". An added callback can be removed by publishing to the same topic with the payload "false". To support multiple (de)registrations, e.g. for message filtering, an optional suffix can be used.

If the callback is triggered, a message with it's payload is published under the corresponding .../callback/io16_bricklet/<UID>/interrupt[/<SUFFIX>] topic for each registered suffix.

This callback is triggered whenever a change of the voltage level is detected on pins where the interrupt was activated with request/io16_bricklet/<UID>/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.

register/io16_bricklet/<UID>/monoflop_done¶

Register Request:	register – Type: bool
Callback Response:	port – Type: char, Range: ["a" to "b"] selection_mask – Type: int, Range: [0 to 255] value_mask – Type: int, Range: [0 to 255]

A callback can be registered for this event by publishing to the .../register/io16_bricklet/<UID>/monoflop_done[/<SUFFIX>] topic with the payload "true". An added callback can be removed by publishing to the same topic with the payload "false". To support multiple (de)registrations, e.g. for message filtering, an optional suffix can be used.

If the callback is triggered, a message with it's payload is published under the corresponding .../callback/io16_bricklet/<UID>/monoflop_done[/<SUFFIX>] topic for each registered suffix.

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