A 2.0.0 release has been published for each package in this library. With this release, all future features will be brought only to this new major version, so users are highly encouraged to migrate from the 1.X.X releases to the new 2.0.0 releases. We have released one final LTS release for the 1.X.X packages that will be supported like any other LTS release.
If you need any help migrating your code to try out the new 2.X.X clients, please see this migration guide.
All Azure IoT SDK users are advised to be aware of upcoming TLS certificate changes for Azure IoT hub and Device Provisioning Service that will impact the SDK's ability to connect. In October 2022, both services will migrate from the current Baltimore CyberTrust CA Root to the DigiCert Global G2 CA root. There will be a transition period beforehand where your IoT devices must have both the Baltimore and Digicert public certificates installed in their certificate store in order to prevent connectivity issues.
For a more in depth explanation as to why the IoT services are doing this, please see this article.
Users of this Java IoT SDK in particular will need to follow slightly different instructions in order to handle this upcoming change. See this document for a more in depth explanation of how to prepare your devices for this certificate migration.
Users who don't follow these instructions will begin experiencing unrecoverable, consistent connection failures from their devices starting June 2022.
If you have any questions, comments, or concerns about this upcoming change, please let us know on our discussions page.
This repository contains the following:
- Azure IoT Hub service SDK for Java: enables developing back-end applications for Azure IoT
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:
For more details on what platforms this SDK supports, see this document.
- Azure IoT Hub device SDK
- Azure IoT Hub service SDK
- Azure IoT Hub Device Provisioning device SDK
- Azure IoT Hub Device Provisioning service SDK
✔️ 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. |
| Digital Twin Client | ✔️ | Set up your backend app to perform operations on plug and play devices. |
## Samples
Within the repository, you can find various types of simple samples that can help you get started.
In order to learn more about logging within this SDK and how to capture its logs, see here.
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.
- Have a technical question? Ask on Stack Overflow with tag “azure-iot-hub”
- Need Support? Every customer with an active Azure subscription has access to support with guaranteed response time. Consider submitting a ticket and get assistance from Microsoft support team
- Found a bug? Please help us fix it by thoroughly documenting it and filing an issue on GitHub (C, Java, .NET, Node.js, Python).
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
- Configure TLS Protocol Version and Ciphers
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, as well as azure pipeline resources used for our gating process
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.
For guidance and important information about certificates, please refer to this blog post from the security team.
The project offers a Long-Term Support (LTS) releases to allow users that do not need the latest features to be shielded from unwanted changes.
Going forward, LTS repo tags are to be named lts_yyyy-mm-dd, where yyyy, mm, and dd are the year, month, and day when the tag was created. An example of such a tag is lts_2021-03-18.
The lifetime of an LTS release is 12 months. During this time, LTS releases may receive bug fixes that fall in these categories:
- security bug fixes
- critical bug fixes (e.g., unavoidable/unrecoverable crashes, significant memory leaks)
No new features or improvements are in scope to be picked up in an LTS branch. A patch will not extend the maintenance or expiry date.
LTS releases may include additional extended support for security bug fixes as listed in the LTS schedule.
This table shows previous LTS releases and end dates.
| Release Link | GitHub Tag | LTS Start Date | Maintenance End Date | LTS End Date |
|---|---|---|---|---|
| 2022-06-17 | 2022-03-04 | 2020-03-04 | 2021-09-31 | 2023-03-31 |
| 2021-06-17 | lts_06_2021 | 2020-06-17 | 2021-12-31 | 2022-06-30 |
| 2020-07-07 | lts_07_2020 | 2020-07-07 | 2020-12-31 | 2021-06-30 |
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.
Microsoft collects performance and usage information which may be used to provide and improve Microsoft products and services and enhance your experience. To learn more, review the privacy statement.