Public API Overview

Public API Overview

The iDigi connector API includes two major software interfaces:

  • iDigi connector function calls
  • iDigi connector application-defined callback

The functions available in the iDigi connector are listed below:

Routine Description
idigi_init() Start the iDigi connector
idigi_step() Execute the iDigi connector and return
idigi_run() Start the iDigi connector and do not return
idigi_initiate_action() Begin an iDigi connector operation, like starting a data transfer

Initialization: idigi_init()

The function idigi_init() is called once at startup to initialize the iDigi connector. The application-defined callback function is passed as an argument; the application-defined callback is used by the iDigi connector to communicate with the application. The idigi_init() function must be called before all other iDigi connector APIs.

Single-threaded model: idigi_step()

The function idigi_step() is called to perform a sequence of operations or events and then returns control back to the caller. This allows a caller to perform other tasks within a single thread or round robin based control loop. A caller must call this API repeatedly to continue iDigi connector operations.

The idigi_step() performs the following operations:

  1. Establish and maintain a connection with the iDigi Device Cloud.
  2. Wait for incoming messages from the iDigi Device Cloud.
  3. Send outstanding messages to the iDigi Device Cloud.

Multi-threaded model: idigi_run()

The function idigi_run() is similar to idigi_step() except it blocks and doesn't return control back to caller unless the iDigi connector encounters an error. This function is typically executed as a separate thread. This is the recommended method of running the iDigi connector within in a multithreaded environment.

To relinquish control of the CPU in a multithreaded environment the iDigi connector calls the receive (app_network_receive) callback with a timeout or will call OS sleep (app_os_sleep).

Initiate an action: idigi_initiate_action()

The function idigi_initiate_action() is used to indicate to the iDigi connector to perform a device-requested action. The currently supported actions are:

  • Initiate a data transfer to the server, described in the data service API
  • Terminate the iDigi connector

Application Callback

The iDigi connector uses a single application-defined callback function to process network events, handle operating system (OS) calls, return device configuration data, and process firmware updates. The callback is also used to report error status and event notification. The application-defined callback is passed into idigi_init() upon startup. When the iDigi connector needs to allocate memory, access the network or perform other actions the application defined callback is called.

The iDigi connector will invoke the application-defined callback to perform the following actions:

  • Obtain configuration information
  • OS calls
  • Networking calls
  • Notify the application of critical events and status
  • Firmware download
  • Handle a device request
  • Request more data when sending data to the iDigi Device Cloud
  • Access file system
  • Access device configurations

Class ID and Request ID enumeration values are used to identify the callback action. The application must perform and return the appropriate action and return data, according to the class and request enumeration values.

Each callback is passed in a Class ID which is defined by the enumerated type Class IDs. For each Class ID there is a set of Request ID's, for example the idigi_class_operating_system the corresponding Request ID's are defined by the enum OS Request IDs.

The parameters for the application-defined callback: request_data, request_length, response_data and response_length are defined by the corresponding class_id and the request_id. There is a section in the documentation for each class of callbacks. For example, the Operating System callbacks are described on the Operating System page.

 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Defines