API Reference

MicroDrop-3 is built on top of the MQTT standard. The various endpoints are listed below (subscriptions being items you can publish to, and broadcasts being channels you can subscribe to).

If you are developing in Python 3 or Javascript: MicroDrop client libraries are available to you which wrap the various channels around Python 3 and ES 6 async standards. Examples are available for both Python and Javascript in the wiki.

Device Model

The device model contains a THREE.js based representation of the fluxel device file.

Device Model Subscriptions

microdrop/trigger/device-model/get-neighbouring-electrodes
microdrop/trigger/device-model/electrodes-from-routes
microdrop/put/device-model/three-object
microdrop/put/device-model/overlay
microdrop/put/device-model/overlays

Device Model Broadcasts

microdrop/device-model/state/three-object
microdrop/device-model/state/overlays

Electrodes Model

The Electrodes Model keeps track of which fluxels are on / off

Electrodes Model Subscriptions

microdrop/put/electrodes-model/active-electrodes
microdrop/trigger/electrodes-model/toggle-electrode

Electrodes Model Broadcasts

microdrop/device-model/state/active-electrodes

Routes Model

The Routes Model keeps track of various droplet paths, as well as handling the execution events

Routes Model Subscriptions

microdrop/put/routes-model/routes
microdrop/put/routes-model/route
microdrop/trigger/routes-model/execute

Routes Model Broadcasts

microdrop/routes-model/state/routes
microdrop/routes-model/state/status