Welcome to AirPhoton.io API’s documentation!

This website documents the AirPhoton API for instrument users. An attempt has been made to cover some basics while building more specific examples. In many cases, the nature of the API and remote instrument control means examples build off of each other.

If you are comfortable with APIs and terminal commands, feel free to search for what you need and jump around, but if you are new to system like this, please read through, get a bearing, and try some examples!

Contents:

• API Server
  • Overview
  • Getting Started
  • users Functionality
  • groups Functionality
  • instruments Functionality
  • controls Functionality
  • controlresponses Functionality
  • checkins functionality
  • data Functionality
• Communication Module API
  • Remote Interface Overview
  • Remote Command: echo
  • Remote Command: setinterval
  • Remote Command: sendcommand
  • Remote Command: sendmlcommand
  • Remote Command: downloadfile
  • Remote Command: transmitfile
  • Remote Command: execscript
• Station Commands
  • echo
  • getid
  • setdate
  • settime
  • setmode
  • listfiles
  • getfile
  • putfile
  • writefile
  • rmfile
  • closefile
  • getstate
  • pausescript
  • unpausescript
  • stopscript
  • startscript
  • status
  • checkscript
• Instrument Deployments
• Changelog
  • 2021-02-08
  • 2020-10-21
  • 2020-10-13