Shell - One Wire Bricklet

This is the description of the Shell API bindings for the One Wire Bricklet. General information and technical specifications for the One Wire Bricklet are summarized in its hardware description.

An installation guide for the Shell API bindings is part of their general description.

Examples

The example code below is Public Domain (CC0 1.0).

Read Ds18b20 Temperature

Download (example-read-ds18b20-temperature.sh)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
#!/bin/sh
# Connects to localhost:4223 by default, use --host and --port to change this

uid=XYZ # Change XYZ to the UID of your One Wire Bricklet

tinkerforge call one-wire-bricklet $uid write-command 0 78 >/dev/null 2>&1 # WRITE SCRATCHPAD
tinkerforge call one-wire-bricklet $uid write 0 >/dev/null 2>&1 # ALARM H (unused)
tinkerforge call one-wire-bricklet $uid write 0 >/dev/null 2>&1 # ALARM L (unused)
tinkerforge call one-wire-bricklet $uid write 127 >/dev/null 2>&1 # CONFIGURATION: 12 bit mode

# Read temperature 10 times
for i in 0 1 2 3 4 5 6 7 8 9; do
    tinkerforge call one-wire-bricklet $uid write-command 0 68 >/dev/null 2>&1 # CONVERT T (start temperature conversion)
    sleep 1 # Wait for conversion to finish
    tinkerforge call one-wire-bricklet $uid write-command 0 190 >/dev/null 2>&1 # READ SCRATCHPAD

    tinkerforge call one-wire-bricklet $uid read
    tinkerforge call one-wire-bricklet $uid read
done

API

Possible exit codes for all tinkerforge commands are:

  • 1: interrupted (ctrl+c)
  • 2: syntax error
  • 21: Python 2.5 or newer is required
  • 22: Python argparse module is missing
  • 23: socket error
  • 24: other exception
  • 25: invalid placeholder in format string
  • 26: authentication error
  • 201: timeout occurred
  • 209: invalid argument value
  • 210: function is not supported
  • 211: unknown error

Command Structure

The common options of the call and dispatch commands are documented here. The specific command structure is shown below.

tinkerforge call one-wire-bricklet [<option>..] <uid> <function> [<argument>..]
Parameters:
  • <uid> -- string
  • <function> -- string

The call command is used to call a function of the One Wire Bricklet. It can take several options:

  • --help shows help for the specific call command and exits
  • --list-functions shows a list of known functions of the One Wire Bricklet and exits
tinkerforge dispatch one-wire-bricklet [<option>..] <uid> <callback>
Parameters:
  • <uid> -- string
  • <callback> -- string

The dispatch command is used to dispatch a callback of the One Wire Bricklet. It can take several options:

  • --help shows help for the specific dispatch command and exits
  • --list-callbacks shows a list of known callbacks of the One Wire Bricklet and exits
tinkerforge call one-wire-bricklet <uid> <function> [<option>..] [<argument>..]
Parameters:
  • <uid> -- string
  • <function> -- string

The <function> to be called can take different options depending of its kind. All functions can take the following options:

  • --help shows help for the specific function and exits

Getter functions can take the following options:

  • --execute <command> shell command line to execute for each incoming response (see section about output formatting for details)

Setter functions can take the following options:

  • --expect-response requests response and waits for it

The --expect-response option for setter functions allows to detect timeouts and other error conditions calls of setters as well. The device will then send a response for this purpose. If this option is not given for a setter function then no response is send and errors are silently ignored, because they cannot be detected.

tinkerforge dispatch one-wire-bricklet <uid> <callback> [<option>..]
Parameters:
  • <uid> -- string
  • <callback> -- string

The <callback> to be dispatched can take several options:

  • --help shows help for the specific callback and exits
  • --execute <command> shell command line to execute for each incoming response (see section about output formatting for details)

Basic Functions

tinkerforge call one-wire-bricklet <uid> search-bus-low-level
Output:
  • identifier-length -- int
  • identifier-chunk-offset -- int
  • identifier-chunk-data -- int,int,..4x..,int
  • status -- int (has symbols)

Returns a list of up to 64 identifiers of the connected 1-Wire devices. Each identifier is 64-bit and consists of 8-bit family code, 48-bit ID and 8-bit CRC.

To get these identifiers the Bricklet runs the SEARCH ROM algorithm, as defined by Maxim.

The following symbols are available for this function:

  • status-ok = 0, for status
  • status-busy = 1, for status
  • status-no-presence = 2, for status
  • status-timeout = 3, for status
  • status-error = 4, for status
tinkerforge call one-wire-bricklet <uid> reset-bus
Output:
  • status -- int (has symbols)

Resets the bus with the 1-Wire reset operation.

The following symbols are available for this function:

  • status-ok = 0, for status
  • status-busy = 1, for status
  • status-no-presence = 2, for status
  • status-timeout = 3, for status
  • status-error = 4, for status
tinkerforge call one-wire-bricklet <uid> write <data>
Parameters:
  • <data> -- int
Output:
  • status -- int (has symbols)

Writes a byte of data to the 1-Wire bus.

The following symbols are available for this function:

  • status-ok = 0, for status
  • status-busy = 1, for status
  • status-no-presence = 2, for status
  • status-timeout = 3, for status
  • status-error = 4, for status
tinkerforge call one-wire-bricklet <uid> read
Output:
  • data -- int
  • status -- int (has symbols)

Reads a byte of data from the 1-Wire bus.

The following symbols are available for this function:

  • status-ok = 0, for status
  • status-busy = 1, for status
  • status-no-presence = 2, for status
  • status-timeout = 3, for status
  • status-error = 4, for status
tinkerforge call one-wire-bricklet <uid> write-command <identifier> <command>
Parameters:
  • <identifier> -- int
  • <command> -- int
Output:
  • status -- int (has symbols)

Writes a command to the 1-Wire device with the given identifier. You can obtain the identifier by calling search-bus. The MATCH ROM operation is used to write the command.

If you only have one device connected or want to broadcast to all devices you can set the identifier to 0. In this case the SKIP ROM operation is used to write the command.

The following symbols are available for this function:

  • status-ok = 0, for status
  • status-busy = 1, for status
  • status-no-presence = 2, for status
  • status-timeout = 3, for status
  • status-error = 4, for status

Advanced Functions

tinkerforge call one-wire-bricklet <uid> set-communication-led-config <config>
Parameters:
  • <config> -- int (has symbols)
Output:

no output

Sets the communication LED configuration. By default the LED shows 1-wire communication traffic by flickering.

You can also turn the LED permanently on/off or show a heartbeat.

If the Bricklet is in bootloader mode, the LED is off.

The following symbols are available for this function:

  • communication-led-config-off = 0, for <config>
  • communication-led-config-on = 1, for <config>
  • communication-led-config-show-heartbeat = 2, for <config>
  • communication-led-config-show-communication = 3, for <config>
tinkerforge call one-wire-bricklet <uid> get-communication-led-config
Output:
  • config -- int (has symbols)

Returns the configuration as set by set-communication-led-config

The following symbols are available for this function:

  • communication-led-config-off = 0, for config
  • communication-led-config-on = 1, for config
  • communication-led-config-show-heartbeat = 2, for config
  • communication-led-config-show-communication = 3, for config
tinkerforge call one-wire-bricklet <uid> get-spitfp-error-count
Output:
  • error-count-ack-checksum -- int
  • error-count-message-checksum -- int
  • error-count-frame -- int
  • error-count-overflow -- int

Returns the error count for the communication between Brick and Bricklet.

The errors are divided into

  • ACK checksum errors,
  • message checksum errors,
  • framing errors and
  • overflow errors.

The errors counts are for errors that occur on the Bricklet side. All Bricks have a similar function that returns the errors on the Brick side.

tinkerforge call one-wire-bricklet <uid> set-bootloader-mode <mode>
Parameters:
  • <mode> -- int (has symbols)
Output:
  • status -- int (has symbols)

Sets the bootloader mode and returns the status after the requested mode change was instigated.

You can change from bootloader mode to firmware mode and vice versa. A change from bootloader mode to firmware mode will only take place if the entry function, device identifier and CRC are present and correct.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

The following symbols are available for this function:

  • bootloader-mode-bootloader = 0, for <mode>
  • bootloader-mode-firmware = 1, for <mode>
  • bootloader-mode-bootloader-wait-for-reboot = 2, for <mode>
  • bootloader-mode-firmware-wait-for-reboot = 3, for <mode>
  • bootloader-mode-firmware-wait-for-erase-and-reboot = 4, for <mode>
  • bootloader-status-ok = 0, for status
  • bootloader-status-invalid-mode = 1, for status
  • bootloader-status-no-change = 2, for status
  • bootloader-status-entry-function-not-present = 3, for status
  • bootloader-status-device-identifier-incorrect = 4, for status
  • bootloader-status-crc-mismatch = 5, for status
tinkerforge call one-wire-bricklet <uid> get-bootloader-mode
Output:
  • mode -- int (has symbols)

Returns the current bootloader mode, see set-bootloader-mode.

The following symbols are available for this function:

  • bootloader-mode-bootloader = 0, for mode
  • bootloader-mode-firmware = 1, for mode
  • bootloader-mode-bootloader-wait-for-reboot = 2, for mode
  • bootloader-mode-firmware-wait-for-reboot = 3, for mode
  • bootloader-mode-firmware-wait-for-erase-and-reboot = 4, for mode
tinkerforge call one-wire-bricklet <uid> set-write-firmware-pointer <pointer>
Parameters:
  • <pointer> -- int
Output:

no output

Sets the firmware pointer for write-firmware. The pointer has to be increased by chunks of size 64. The data is written to flash every 4 chunks (which equals to one page of size 256).

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

tinkerforge call one-wire-bricklet <uid> write-firmware <data>
Parameters:
  • <data> -- int,int,..61x..,int
Output:
  • status -- int

Writes 64 Bytes of firmware at the position as written by set-write-firmware-pointer before. The firmware is written to flash every 4 chunks.

You can only write firmware in bootloader mode.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

tinkerforge call one-wire-bricklet <uid> set-status-led-config <config>
Parameters:
  • <config> -- int (has symbols)
Output:

no output

Sets the status LED configuration. By default the LED shows communication traffic between Brick and Bricklet, it flickers once for every 10 received data packets.

You can also turn the LED permanently on/off or show a heartbeat.

If the Bricklet is in bootloader mode, the LED is will show heartbeat by default.

The following symbols are available for this function:

  • status-led-config-off = 0, for <config>
  • status-led-config-on = 1, for <config>
  • status-led-config-show-heartbeat = 2, for <config>
  • status-led-config-show-status = 3, for <config>
tinkerforge call one-wire-bricklet <uid> get-status-led-config
Output:
  • config -- int (has symbols)

Returns the configuration as set by set-status-led-config

The following symbols are available for this function:

  • status-led-config-off = 0, for config
  • status-led-config-on = 1, for config
  • status-led-config-show-heartbeat = 2, for config
  • status-led-config-show-status = 3, for config
tinkerforge call one-wire-bricklet <uid> get-chip-temperature
Output:
  • temperature -- int

Returns the temperature in °C as measured inside the microcontroller. The value returned is not the ambient temperature!

The temperature is only proportional to the real temperature and it has bad accuracy. Practically it is only useful as an indicator for temperature changes.

tinkerforge call one-wire-bricklet <uid> reset
Output:no output

Calling this function will reset the Bricklet. All configurations will be lost.

After a reset you have to create new device objects, calling functions on the existing ones will result in undefined behavior!

tinkerforge call one-wire-bricklet <uid> write-uid <uid>
Parameters:
  • <uid> -- int
Output:

no output

Writes a new UID into flash. If you want to set a new UID you have to decode the Base58 encoded UID string into an integer first.

We recommend that you use Brick Viewer to change the UID.

tinkerforge call one-wire-bricklet <uid> read-uid
Output:
  • uid -- int

Returns the current UID as an integer. Encode as Base58 to get the usual string version.

tinkerforge call one-wire-bricklet <uid> get-identity
Output:
  • uid -- string
  • connected-uid -- string
  • position -- char
  • hardware-version -- int,int,int
  • firmware-version -- int,int,int
  • device-identifier -- int (has symbols)

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