Getting Started with the API

API

The API is described in 7 parts. Presented here in a reasonable order for learning:

1. API initialization and device discovery Functions to support API initialization and device discovery. The API must be initialized before first use with OmStartup(), and shut down after use with OmShutdown().
   
2. Device status Functions to support querying the device version, battery level, health and time, and setting of the time and LED indicator.
3. Device settings and meta-data Functions to support reading and writing device settings and other meta-data, including clearing the device data storage.
   
4. Data download Functions to provide simultaneous download from multiple devices.
   
5. Return codes API return and error codes. The return values to most API functions are plain int types.
6. Date/time type A representation of a date and time used by the API functions. A single integer value is used to pack the date/time for a simpler, cross-language, API.
   
7. Binary data file reader Functions to read a binary data file.
   

See also

Example code that covers a range of uses of the API.