busytag_tool

Python library and CLI to interact with Busy Tag devices using the USB CDC interface.

Installation

$ pip install busytag

CLI usage

If you have multiple devices connected to your machine, you should specify the port with the --device flag. If only one device is connected, the tool will automatically use it.

$ busytag-tool

	USAGE: busytag-tool [flags] <command> [<args>]

Available commands:
  help: Prints this message
  list_devices: Lists available devices
  info: Displays device information
  list_pictures: Lists pictures in device
  list_files: Lists files in device
  get_picture: Gets the filename of the picture being shown
  set_picture <filename>: Sets the picture shown in the device
  put <filename>: Uploads <filename>
  get <filename>: Copies <filename> from the device to the working directory
  rm <filename>: Deletes <filename>
  set_led_solid_color <6 hex RGB colour>: Sets the LEDs colour
  apply_led_preset <preset name>: Sets the LEDs colour according to a preset
  get_brightness: Gets current display brightness
  set_brightness <brightness>: Sets current display brightness (int between 1 and 100, inclusive

$ busytag-tool set_picture coding.png

Config

A config file is created at ~/.busytag.toml. You can add "led preset" entries there, which can then be used with the apply_led_preset to change the device's LED colours. For example, here are two entries, one that applies the same colour to all LEDs, and another that alternates colours:

[[led_presets.red]]
pins = 127
color = 'FF0000'

[[led_presets.rb]]
pins = 85
color = 'FF0000'

[[led_presets.rb]]
pins = 42
color = '0000FF'

The BusyTag device has seven LEDs (with the first one, 0, at the bottom left of the device), identified in this tool by powers of two. The pins entry in the config is the sum of which pins we want to apply the colour (so 127 applies to all, while 85 applies to pins 0, 2, 4 and 6).

API usage

from busytag import Device, LedConfig, LedPin

bt = Device('/dev/fooBar')
bt.set_active_picture('coding.gif')
bt.set_led_solid_color(LedConfig(LedPin.ALL, 'FF0000'))