Yocto Project guide¶
Here we have a guide with the necessary steps for adding UpdateHub, either in a project that already exists or in a new project. Each step provides a brief description of the process that must be performed and a link to a section with more detailed information about this process.
Before you start, we ask you to check if your board is supported by UpdateHub.
If your board still does not have support or you encounter difficulties we will be happy to assist you through our Gitter or contact us at email@example.com
First step: adding layer¶
Create project from scratch¶
For the creation of a project that already has the necessary layers to support UpdateHub we recommend using the platform that will download and add the necessary layers automatically, allowing you to start your implementation quickly.
Integrating onto a existing project¶
In a finished or under development project, the way to integrate UpdateHub is done by adding layers directly.
Second step: creating a product¶
Create a Product is necessary for some variables such as the product identifier to be generated. These variables must be included in the image that will be generated so that the device has the necessary data to be authorized on the UpdateHub server when accessing it.
To create a product you need to be logged into your UpdateHub Cloud account.
Third step: requesting an Access Key¶
Access key is a variable that Updatehub uses to guarantee the authenticity of a device when it requests access to the server.
Generating an Access Key is easy and after just putting it in a project's settings before the image that will be loaded on the devices is generated.
Just like creating a product, creating a access key takes place within the Dashboard
Fourth step: configuring the variables¶
Here we show how to setting up the UpdateHub variables necessary for the correct functioning of UpdateHub. Definitions of variables as well as other variables can be found in the Glossary of variables.
Fifth step: in your board¶
After adding the necessary layers and configuring the variables now just generate the image with the bitbake command, save the image on the target devices and that's it!
Sixth step: sending a package to server¶
When changes occur in the original image that is present in devices in the field, it is necessary to update these devices by sending the package with the changed image to the UpdateHub server for it to be applied.
Congratulations! Your UpdateHub support is up and running.
Can't run a tutorial step? Please contact us at Gitter so we can help you.