Connecting software to the Itron network
Whether you are looking to leverage third party data available on Itron network and Data Platform or your software application needs to leverage data from your own devices, there are a variety of choices for connecting software with our platform. There are full cloud based solutions as well as options to integrate directly to Itron sotware applications in a more tightly coupled way. This guide will help you understand the options and find which is right for you.
Cloud Based Options
Most cloud based options make use of APIs accessing data stored in our Data Platform. The Data Platform can store data from just about any device connected to the network as well as data from other sources. Network data stored in the Data Platform includes device information (e.g. type, schema, provisioning, status etc), location information, sensor schema and measurements, and events to name a few. This data can be from your own devices or you can work with third party data owners or Itron to write applications leveraging the Data Platform stored information.
If your software needs to access devices directly for control or device and sensor data collection you can use our cloud based API implementing the CoAP protocol.
Itron Application Direct Integration
We provide a number of connection options for integrating directly to our software applications through web services or application exports to file or queues. This section will lead you through the options and help you choose the right application and connection option.
Software Connectivity Options and Use Cases
Itron Data Platform & Cloud APIs
- Data Platform APIs - API access to any data stored in the Data Platform
- Your own devices or those of third parties you are working with
- Most common use case is access to IOT device and sensor data from devices integrated with one of our Dev Kits and written to the Data Platform
- CoAP APIs - direct access to CoAP device resources on the Itron Networked Solutions Network
- Most common use case is direct access to IOT devices integrated with one of our Dev Kits for control, configuration, or data collection
- Sensor and device measurements and outputs collection
- Control - end device control such as on/off or actuation
- Configuration - such as thresholds
- Your own devices or those of third parties you are working with
- Most common use case is direct access to IOT devices integrated with one of our Dev Kits for control, configuration, or data collection
Itron Application APIs
- AMM Connectivity - for utility batch meter data (see Smart Utility page for some specific use cases)
- HCM Connectivity - for home area network (HAN) device management
- ODS Connectivity - for outage detection and management
- SensorIQ Connectivity - for high frequency and event device data from devices integrated with an Itron Networked Solutions NIC
Data Platform APIs
- Use Cases - API access to any data stored in the Data Platform
- Your own devices or those of third parties you are working with
- Most common use case is access to IOT device and sensor data from devices integrated with one of our Dev Kits and written to the Data Platform
- Connects With: Data Platform
- API Architecture: REST
Steps to Getting Started
- Learn About the Data Platform and APIs
- Simulate Device and Sensor Data for Application Development
- Use Starfish Studio to model and simulate device and sensor data for application development.
- Use Starfish Studio API View to try out the APIs with an easy to use interface.
- Learn How to Implement a Web Application on our Data Platform
- Use the Data Platform Plotting Example Application to learn how to implement a web application with the Data Platform APIs. The documentation will also provide instructions and examples for creating simulated test data. Source code is supplied.
CoAP APIs
- Use Case - direct access to CoAP device resources on the Itron Networked Solutions Network
- Most common use case is direct access to IOT devices integrated with one of our Dev Kits for control, configuration, or data collection
- Sensor and device measurements and outputs collection
- Control - end device control such as on/off or actuation
- Configuration - such as thresholds
- Your own devices or those of third parties you are working with
- Most common use case is direct access to IOT devices integrated with one of our Dev Kits for control, configuration, or data collection
- Connects With: CoAP Resources/Devices on the network
- API Architecture: CoAP over UDP
Steps to Getting Started
- Learn About CoAP on our Network
- Learn How to Use Our APIs
- Learn How to Implement Your CoAP Application
- Use the Windows CoAP Client Application as a working example to understand how to implement CoAP applications in a Windows environment. This CoAP client with an intuitive MS Windows UI for communicating with devices via CoAP. Source code is included with the application.
- Use the Java CoAP Client included with the Milli CoAP Temperature Sensor Example Application as a working example to understand how to implement CoAP applications in a Java. This is a command line tool that can be run on Linux, Windows, and MacOS.Source code is included.
- Watch Our Tutorial Videos
- Useful Test Tools
- Use the Windows CoAP Server Application connected to a Milli Dev Kit to simulate a CoAP server sensor. This is an easy way to generate live CoAP sensor data using a working example. Source code is included.
- Understand the full end to end connectivity of a CoAP sensor with the Milli CoAP Temperature Sensor Example Application. This is a full end to end reference solution using the Milli CoAP Temperature Sensor Reference Application. The solution includes data ingestion into the Data Platform and a Java application to visualize plots of the temperature by leveraging Data Platform APIs.
- Learn how to write sensor code on the Arduino board with the Milli Dev Kit Example Arduino Application. This is an example application for a temperature sensor implemented as a CoAP server on an Arduino processor board communicating on the network through the Milli Dev Kit. Source code and instructions.
- Additional CoAP Resources
AMM (Automated Meter Management) Connectivity
- Use Case - utility batch or on demand meter data. Some common use cases are
- Customer Information Systems (CIS)
- Meter Data Management (MDM) systems
- Prepay applications
- Volt-Var Optimization (VVO)
- Conservation Voltage Reduction (CVR)
- Connects With: Itron Networked Solutions' AMM product
- Connectivity Architecture Options
- AMM Exports to files
- AMM Exports to TIBCO Queues
- SOAP Web Services APIs
- Resources
- AMM Integration Guide
- AMM Web Services Guide
- AMM Web Service WSDL
- AMM Export Schema XSD
- AMM On Demand Read Export Schema XSD
- AMM Events Reference
- AMM Export File Examples
- Sample Electric Reading File Export
- Sample Gas Reading File Export
- Sample Device Details Export
- Sample Location Details Export
HCM (HAN Communication Manager) Connectivity
- Use Case - home area network (HAN) device management
- Thermostats
- Smart appliances
- Range extenders
- Load control switches
- Pool Pumps
- AC Units
- Connects With: Itron's HCM product
- Connectivity Architecture: SOAP Web Services APIs
- Resources
- HCM Integration Guide
- HCM Web Service WSDL
- HAN Test Kit
- HAN Test Kit User Guide
- HAN Test Kit Release Notes
- HAN Interoperability Technical Requirements r1.11
- Zigbee Specs for HAN Integration
ODS (Outage Detectent System) Connectivity
- Use Case - Outage Management
- Connects With: Itron Networked Solutions' ODS product
- Connectivity Architecture: SOAP Web Services APIs
- Resources
- ODS Integration Guide
- ODS Web Service WSDL
- ODS Release Notes
SensorIQ Connectivity
- Use Case - high frequency device data and device event data
- Connects With: Itron Networked Solutions' SensorIQ product
- Connectivity Architecture Options
- AMM Exports to files
- AMM Exports to TIBCO Queues
- SOAP Web Services APIs
- Resources
- SensorIQ Integration Guide
- SensorIQ Web Services Guide
- SensorIQ Web Service WSDL
- SensorIQ Profile Schema XSD
- SensorIQ Release Notes
- SensorIQ Sample Profiles