PurpleDrop Driver Software Documentation

The purpledrop-driver project contains software which acts as a control gateway for the PurpleDrop USB device.

The main utilities provided by this library are the pdserver and pdcam executables. These two daemons provide the purpledrop control gateway and raspberry pi camera support, respectively.

Startup Example

To run the gateway, simply run the following commands:

pdserver --board "misl_v4.1"
pdcam server

You can replace “misl_v4.1” with the name of the electrode board you are using. The name references one of the available electrode board definitions, as described in Board Definitions. You can also forego the pdcam command altogether if you do not require video.

Contents

• Executable Commands
  • pdcli
  • pdcam
  • pdrecord
  • pdlog
• Board Definitions
  • File Structure
  • Grid Objects
  • Peripherals and Peripheral Templates
  • Registration
  • Oversized Electrodes
• Calibration
  • Electrode Offset Capacitance
  • Capacitance Amplifier Offset Calibration
• Simulated Device
• HTTP APIs
  • RPC API
  • Websocket Event Stream
• Internal API Reference
  • electrode_board
  • pdcam module
  • messages