Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: device profile operation guide #3102

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
61 changes: 61 additions & 0 deletions docs/src/operate/c8y/device-profiles.md
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.
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.
Original file line number Diff line number Diff line change
@@ -1,12 +1,10 @@
---
title: Device profile
title: Device profiles
tags: [Reference, Device Profile, Firmware Management, Software Management, Configuration Management]
sidebar_position: 6
description: Device profile API proposal
---

# Device profile

A device profile defines any desired combination of firmware, software and associated configurations to be installed on a device.
Device profiles are used to get a fleet of devices into a consistent and homogeneous state by having the same set of firmware,
software and configurations installed on all of them.
Expand Down