index :: hw

hw.arduino

Arduino device

available since version: 0.5

---

information

Arduino serial port tha t supports reconnect and hotplug. If no properties are given tries to connect to first available and not opened device. If @reconnect flag is given, waits for device hotplug and reconnects to it.

arguments:

• PORT serial port name, eg.: COM3 on Windows, /dev/ttyACM0 on Linux and /dev/cu.usbmodem411 on MacOSX
  type: symbol
  

• RATE serial baud rate
  type: int
  

methods:

• connect manually connect to device
  

• disconnect disconnect from device
  

properties:

• @port (initonly) Get/set name of arduino serial port, eg.: COM3 on Windows, /dev/ttyACM0 on Linux and /dev/cu.usbmodem411 on MacOSX. If specified on creation tries to connect to this device only
  type: symbol
  

• @serial Get/set USB device serial number. If specified at creation, tries to connect to devices only with such serial number
  type: symbol
  

• @rate Get/set serial baud rate. Standard value supported by most serial ports: 110, 300, 600, 1200, 2400, 4800, 9600, 14400, 19200, 28800, 38400, 56000, 57600, 115200
  type: int
  enum: 57600, 110, 300, 600, 1200, 2400, 4800, 9600, 14400, 19200, 38400, 56000, 115200, 128000, 256000
  default: 57600
  

• @vendor_id Get/set USB device vendor id. If specified at creation, tries to connect to devices only with such vendor. Note: vendor id is specified in decimal mode, not in hex
  type: int
  default: 0
  

• @product_id Get/set USB device product id. If vendor and product ids are specified at creation, tries to connect to devices only with such properties. Note: product id is specified in decimal mode, not in hex
  type: int
  default: 0
  

• @reconnect (initonly) Get/set enables hot-pluggin
  type: flag
  default: 0
  

• @connected (readonly) Get state of connection to device
  type: bool
  default: 0
  

• @devices (readonly) Get list of found Arduino devices
  type: list
  

• @on_connect Get/set function called every time on connect
  type: symbol
  

inlets:

• sends float value in byte range [0-255] to arduino device
  type: control

outlets:

• outputs received byte from arduino
  type: control

keywords:

arduino

Authors: Serge Poltavsky

License: GPL3 or later