Add the softwareUpdatable feature to your device

Your devices which have been provisioned to work with Bosch IoT Device Management have to implement the softwareUpdatable feature in order to be recognized as a target for a potential firmware or software update.
How to implement the softwareUpdatable feature on any device is described in the detailed specification and integration guide. However, as it might be complex to implement this feature if you are a beginner, you can add this feature to your device by using its definition available as a Vorto model on our GitHub repository.

1. Navigate to the Vorto models view of the Developer Console.

2. In the search bar type softwareUpdatable.

3. Select the model with version 2.0.0.

4. Copy its ID (up to the version, included - org.eclipse.hawkbit.swupdatable-SoftwareUpdatable-2.0.0), as you will need to enter it in the next step.

Then, as shown on the image below:

1. Navigate to the Things view on the left sidebar.

2. Select your provisioned device.

3. Open its Features blade, Manage tab.

4. Click the + icon to add a new feature.

5. In the ID field, enter a unique ID for your new feature, e.g. softwareUpdate.

6. In the Properties field, copy/paste the code block below, which contains the mandatory property for our feature, namely the softwareModuleType property.
   As a value of this property enter a string of your choice. This name will later be displayed in the list of available Software Module types in the Rollouts UI.

   {

   "status": {

   "softwareModuleType": "MySimpleType"

   }

   }

7. In the Definitions field, click the + icon to add a definition for this feature.

8. In the ID, field paste the ID of the Vorto model you just copied

   To comply with the required format (namespace:name:version) replace the dashes with colons, as shown below:

   org.eclipse.hawkbit.swupdatable:SoftwareUpdatable:2.0.0

9. Confirm the definition with OK and then again OK to save the whole new feature.

Navigate to Developer Console > Home > Software updates > Rollouts > Deployment view and find your device on the list of targets in the Rollouts UI.

Upload the software to be distributed to the device

1. Navigate to the Upload view on the left sidebar. This is where you can prepare the software or firmware update which will be deployed on the device (aka target).

2. Click the +icon in the Software Module column. With this you can create a new software module of the type accepted by your device - the one which we have set in the softwareUpdatable feature properties, in our case MySimpleType.

3. In the dialog that opens, select the relevant type from the combobox.

4. Fill in the other required fields and Save the software module.

5. Click the Upload button (bottom right corner) to select your artifacts or directly drag and drop them in the designated area.

6. The uploaded artifact will appear in the right column.

Describe the distribution details

Navigate to the Distributions view on the left sidebar. This is where you can prepare a distribution which will include the newly created software module.

First you need to create a new distribution set type and indicate that it will accept software modules of the type we created in the previous step.

1. Click the configure icon in the left column.

2. Click the + icon for create.

3. In the dialogue that opens (as on the screenshot below), enter a name and a key of your choice.

4. Select MySimpleType in the mid column.

5. Use the forward arrow in order to add it to the column of Selected software module types.

6. Confirm with Save.

When your new type is ready, you can create the distribution itself.

1. Click the +icon in the Distributions column in the middle.

2. Fill in the required fields of the dialogue as you did with with the software module.

3. The new distribution will appear in the Distributions column.

4. Select the software module from the column to the right and drag and drop it on the distribution.

5. Confirm the assignment on the pop-up.

Assign a distribution to a device

As a last step, go to the Deployment view from the left sidebar. There:

1. Drag and drop the distribution set on the target device.

2. Confirm the assignment with the default Forced option on the pop-up.

You can now monitor the progress and status of your software update in the action history area to the right.

With this, you have reached the end of our getting started guide.