-
Notifications
You must be signed in to change notification settings - Fork 54
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #3102 from reubenmiller/docs-operate-device-profiles
docs: device profile operation guide
- Loading branch information
Showing
8 changed files
with
62 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,61 @@ | ||
--- | ||
title: Device Profiles | ||
tags: [Operate, Device Profile, Firmware Management, Software Management, Configuration Management] | ||
description: Managing device profiles on devices | ||
--- | ||
|
||
## Management | ||
|
||
%%te%% enables you to manage the firmware, software and configuration for a device in a single operation which makes it suitable for managing a large fleet of devices. The following sections detail how to create and assign a device profile to a device. Using Cumulocity IoT, you can either assign a device profile using a single operation (described on this page), or by using a [bulk operation](https://cumulocity.com/docs/device-management-application/monitoring-and-controlling-devices/#to-add-a-bulk-operation) to assign it to a fleet of devices. | ||
|
||
:::info | ||
For more detailed information on the Cumulocity IoT **Device Management** features, please check out the [official documentation](https://cumulocity.com/docs/device-management-application/managing-device-data/#managing-device-profiles). | ||
::: | ||
|
||
### To add a new device profile {#add-to-repo} | ||
|
||
A device profile can be created by using the following steps. Afterwards, the device profile can be assigned to a specific device by following the [instructions](#install) in the next section. | ||
|
||
1. Navigate to the *Management* → *Device profiles* page | ||
|
||
![Create new device profile](images/device-profile-repo-1-list.png) | ||
|
||
The page will display the existing device profiles (if any) that will be available for selection to the user whilst managing a device. | ||
|
||
2. Select *Add device profile* and fill in the details | ||
|
||
<p align="center"> | ||
<img width="100%" src={require('./images/device-profile-repo-2-add-device-profile-empty.png').default} alt="Add software" /> | ||
</p> | ||
|
||
:::tip | ||
If you leave the *Device type* field blank, then the device profile can be applied to every kind of device. | ||
::: | ||
|
||
3. Configure the device profile by adding any combination of *Firmware*, *Software* and *Configuration* | ||
|
||
<p align="center"> | ||
<img width="100%" src={require('./images/device-profile-repo-4-device-profile-details.png').default} alt="Add software" /> | ||
</p> | ||
|
||
:::note | ||
Currently device profiles don't support/show the software type field in the UI. If you are using more than 1 software type on a device, then you will need to encode the software type into the software version, e.g. `1.2.3::apt`. | ||
::: | ||
|
||
### To install a device profile on a device {#install} | ||
|
||
The following procedure describes the steps involved to assign a device profile to a device. | ||
|
||
:::tip | ||
Only previously created device profiles can be selected. If you don't see any device profiles in the dropdown menu, then make sure you add a device profile using [these instructions](#add-to-repo). | ||
::: | ||
|
||
1. Select the device profile you want to assign to the device | ||
|
||
![Select device profile](images/device-profile-install-1-select.png) | ||
|
||
2. Review the device profile changes | ||
|
||
3. Select *Assign device profile* and wait for the operation to complete | ||
|
||
![Assign device profile](images/device-profile-install-2-assign.png) |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+767 KB
docs/src/operate/c8y/images/device-profile-repo-2-add-device-profile-empty.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+761 KB
...rc/operate/c8y/images/device-profile-repo-3-add-device-profile-with-details.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+756 KB
docs/src/operate/c8y/images/device-profile-repo-4-device-profile-details.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 1 addition & 3 deletions
4
docs/src/references/agent/device-profile.md → docs/src/references/agent/device-profiles.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters