The imp API Cookbook

The imp API Cookbook provides a set of recipes which will help you achieve key agent and device tasks in your own software. Each includes ready-to-use snippets of code that you can adapt or drop straight into your own application.

Factory Operation

• Factory Firmware — Software for your connected factory

Network Management

• Detecting Available Network Interfaces

Communications

• Basic Internet-to-Agent Communications — Handle incoming HTTP requests
• Basic Agent-to-Internet Communications — Send HTTP requests to web APIs
• Long-polling Agent-to-Internet Communications — Send long-term HTTP requests to web APIs
• Agent-Device Communications — How to manage messaging between agent and device
• Enforce HTTPS Connections To Agents — How to block incoming HTTP connections

Connection State

• Unexpected Device Disconnections — Keep your device running when WiFi goes down
• Monitoring Device Disconnections From The Agent — When to send a warning that the device is no longer connected to its agent
• Agent And Device Non-Blocking Code Loops — Recommended code flow for long loops in imp code
• How To Disconnect And/or Deep-sleep Devices Correctly — Make sure impOS has sufficient leeway to process messages, Squirrel/OS updates etc.

Data Handling

• Agent Data Persistence — Preserve crucial data across agent restarts and device power cycles
• Device Data Persistence — Persist data across during device deep sleep
• Encoding Containers To JSON On The Device — Iterate through complex data structures
• Base64 Encoding, Decoding On The Device — Make use of a common data encoding scheme

Miscellaneous

• Random Numbers In Squirrel — Functions for generating pseudo-random numbers
• Boot-time Device Information — Log useful development-device details at start-up
• Serial Logging — Send device log messages out via UART