index :: proto

proto.sp.alpaca

protocol parser for Arduino-based CEAMMC footswitch

available since version: 0.8

---

methods:

• brightness set LED brightness
  parameters:
  • VAL value
    type: float
    required: True
    
• char draw char at specified position
  parameters:

  • CH char symbol or int value from 0 to 9
    type: atom
    required: True
    

  • [XOFF] horizontal character offset
    type: int
    

• char draw char at specified position
  parameters:

  • CH char symbol or int value from 0 to 9
    type: atom
    required: True
    

  • [XOFF] horizontal character offset
    type: int
    

• clear clear LED display
  

• col draw column pixels
  parameters:

  • N column index
    type: int
    required: True
    

  • BITS list of 0 and 1
    type: list
    required: True
    

• dump dumps all object info to Pd console window.
  

• fill fill LED display
  

• invert invert LED display
  

• mode set device jack mode
  parameters:

  • IDX left (0) or right (1) device side
    type: int
    required: True
    

  • MODE output mode: none - no output, digital1 - send only first button press, digital2 - send only second button press, digital - send both buttons press, analog - send analog value (from pedal), analog_row - send raw analog values (pair)
    type: symbol
    required: True
    

• pixel draw/clear pixel on display matrix (6x8).
  parameters:

  • X x-pixel coordinate
    type: int
    required: True
    

  • Y y-pixel coordinate
    type: int
    required: True
    

  • ON/OFF draw (1) or clear (0)
    type: int
    required: True
    

• row draw row pixels
  parameters:

  • N row index
    type: int
    required: True
    

  • BITS list of 0 and 1
    type: list
    required: True
    

• str draw string
  parameters:
  • STR string or int value from -9 to 99
    type: atom
    required: True
    

• sync force device to send it's button and mode state
  

• version? outputs device protocol version as message: [version N]
  

inlets:

• input byte value from arduino
  type: control

outlets:

• output parsed messages from device
  type: control

keywords:

protocol diy alpaca footswitch

Authors: Serge Poltavsky

License: GPL3 or later