This repository contains the following:
- Azure IoT Hub device SDK for Java: to connect client devices to Azure IoT Hub (supports Java 7+ and Android API 17+)
- Azure IoT Hub service SDK for Java: enables developing back-end applications for Azure IoT (supports Java 7+)
The API reference documentation for the device SDK is here.
The API reference documentation for the service SDK is here.
To find SDKs in other languages for Azure IoT, please refer to the azure-iot-sdks repository
Visit Azure IoT Dev Center to learn more about developing applications for Azure IoT.
Devices and data sources in an IoT solution can range from a simple network-connected sensor to a powerful, standalone computing device. Devices may have limited processing capability, memory, communication bandwidth, and communication protocol support. The IoT device SDKs enable you to implement client applications for a wide variety of devices.
- On Linux and Windows:
- Using Maven: the simplest way to use the Azure IoT SDKs for Java to develop apps is to leverage Maven packages:
- Clone the repository:
git clone https://github.com/Azure/azure-iot-sdk-java.git- Working with the SDKs code: if you are working with the SDKs code to modify it or contribute changes, then you can clone the repository and build the libraries:
- On Android: our Java device SDK can be used on Android using the API version 17 and higher:
✔️ feature available ✖️ feature planned but not supported ➖ no support planned
| Features | mqtt | mqtt-ws | amqp | amqp-ws | https | Description |
|---|---|---|---|---|---|---|
| Authentication | ✔️ | ✔️* | ✔️* | ✔️* | ✔️ | Connect your device to IoT Hub securely with supported authentication, including private key, SASToken, X-509 Self Signed over MQTT and HTTP, and X-509 Certificate Authority (CA) Signed over MQTT. *IoT Hub only supports X-509 CA Signed over AMQP and MQTT at the moment. X509 Self Signed and X509 CA Signed over AMQP is in progress. |
| Send device-to-cloud message | ✔️* | ✔️* | ✔️* | ✔️* | ✔️* | Send device-to-cloud messages (max 256KB) to IoT Hub with the option to add custom properties. IoT Hub only supports batch send over AMQP and HTTPS only at the moment. This SDK supports batch send over HTTP. * Batch send over AMQP and AMQP-WS, and add system properties on D2C messages are in progress. |
| Receive cloud-to-device messages | ✔️* | ✔️* | ✔️* | ✔️* | ✔️ | Receive cloud-to-device messages and read associated custom and system properties from IoT Hub, with the option to complete/reject/abandon C2D messages. *C2D message size limit of 256 KB over MQTT and AMQP is in progress. IoT Hub supports the option to complete/reject/abandon C2D messages over HTTPS and AMQP only at the moment. |
| Device Twins | ✔️* | ✔️* | ✔️* | ✔️* | ➖ | IoT Hub persists a device twin for each device that you connect to IoT Hub. The device can perform operations like get twin tags, subscribe to desired properties. *Send reported properties version and desired properties version are in progress. |
| Direct Methods | ✔️* | ✔️* | ✔️* | ✔️* | ➖ | IoT Hub gives you the ability to invoke direct methods on devices from the cloud. The SDK supports handler for generic operation. |
| Upload file to Blob | ➖ | ➖ | ➖ | ➖ | ✔️* | A device can initiate a file upload and notifies IoT Hub when the upload is complete. File upload requires HTTPS connection, but can be initiated from client using any protocol for other operations. *Upload file to Blog with X509 certificate is in progress. |
| Connection Status and Error reporting | ✖️ | ✖️ | ✖️ | ✖️ | ✖️ | Error reporting for IoT Hub supported error code. |
| Retry policies | ✖️ | ✖️ | ✖️ | ✖️ | ✖️ | Retry policy for unsuccessful device-to-cloud messages have three options: no try, exponential backoff with jitter (default) and custom. |
| Devices multiplexing over single connection | ➖ | ➖ | ✖️ | ✖️ | ✖️ | |
| Connection Pooling - Specifying number of connections | ➖ | ➖ | ✖️ | ✖️ | ✖️ |
✔️ feature available ✖️ feature planned but not supported ➖ no support planned
| Features | Support | Description |
|---|---|---|
| Identity registry (CRUD) | ✔️ | Use your backend app to perform CRUD operation for individual device or in bulk. |
| Cloud-to-device messaging | ✔️ | Use your backend app to send cloud-to-device messages in AMQP and AMQP-WS, and set up cloud-to-device message receivers. |
| Direct Methods operations | ✔️ | Use your backend app to invoke direct method on device. |
| Device Twins operations | ✔️* | Use your backend app to perform device twin operations. *Twin reported property update callback and replace twin are in progress. |
| Query | ✔️ | Use your backend app to perform query for information. |
| Jobs | ✔️ | Use your backend app to perform job operation. |
| File Upload | ✔️ | Set up your backend app to send file upload notification receiver. |
Whithin the repository, you can find various types of simple samples that can help you get started.
If you encounter any bugs, have suggestions for new features or if you would like to become an active contributor to this project please follow the instructions provided in the contribution guidelines.
If you are having issues using one of the packages or using the Azure IoT Hub service that go beyond simple bug fixes or help requests that would be dealt within the issues section of this project, the Microsoft Customer Support team will try and help out on a best effort basis. To engage Microsoft support, you can create a support ticket directly from the Azure portal. Escalated support requests for Azure IoT Hub SDKs development questions will only be available Monday thru Friday during normal coverage hours of 6 a.m. to 6 p.m. PST. Here is what you can expect Microsoft Support to be able to help with:
- Client SDKs issues: If you are trying to compile and run the libraries on a supported platform, the Support team will be able to assist with troubleshooting or questions related to compiler issues and communications to and from the IoT Hub. They will also try to assist with questions related to porting to an unsupported platform, but will be limited in how much assistance can be provided. The team will be limited with trouble-shooting the hardware device itself or drivers and or specific properties on that device.
- IoT Hub / Connectivity Issues: Communication from the device client to the Azure IoT Hub service and communication from the Azure IoT Hub service to the client. Or any other issues specifically related to the Azure IoT Hub.
- Portal Issues: Issues related to the portal, that includes access, security, dashboard, devices, Alarms, Usage, Settings and Actions.
- REST/API Issues: Using the IoT Hub REST/APIs that are documented in the documentation.
- Azure IoT Hub documentation
- Prepare your development environment to use the Azure IoT device SDK for Java
- Setup IoT Hub
- Java SDKs API reference
This folder contains dependencies that are common across all clients
Contains Azure IoT Hub client components that provide the raw messaging capabilities of the library. Refer to the API documentation and samples for information on how to use it.
This folder contains application development guides and device setup instructions.
This folder contains end to end tests source code for running on jvm and android.
This folder contains scripts to build and run Java SDK provided proper environmental variables are set
Contains libraries that enable interactions with the IoT Hub service to perform operations such as sending messages to devices and managing the device identity registry. Refer to API documentation and samples for more details.
The project offers a Long Term Support (LTS) version to allow users that do not need the latest features to be shielded from unwanted changes.
A new LTS version will be created every 6 months. The lifetime of an LTS branch is currently planned for one year. LTS branches receive all bug fixes that fall in one of these categories:
- security bugfixes
- critical bugfixes (crashes, memory leaks, etc.)
No new features or improvements will be picked up in an LTS branch.
LTS branches are named lts_mm_yyyy, where mm and yyyy are the month and year when the branch was created. An example of such a branch is lts_07_2017.
Below is a table showing the mapping of the LTS branches to the packages released
| Maven Package | Github Branch | LTS Status | LTS Start Date | Maintenance End Date | Removed Date |
|---|---|---|---|---|---|
| 1.x.x | lts_07_2017 | Active | 2017-07-01 | 2017-12-31 | 2018-06-30 |
- 1 All scheduled dates are subject to change by the Azure IoT SDK team.
This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.