Skip to content
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
8 changes: 4 additions & 4 deletions ADVANCED.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ device_credentials_installer -d --ca *_ca.pem --ca-key *_prv.pem --verify --id-i
## nRF Cloud Device Onboarding

The `nrf_cloud_onboard` script performs device onboarding with nRF Cloud.
Your nRF Cloud REST API key is a required parameter and can be found on your [User Account page](https://nrfcloud.com/#/account).
Your nRF Cloud REST API key is a required parameter and can be found on your [User Account page](https://app.nrfcloud.com/#/account).
Also required is a CSV file compatible with the [onboarding endpoint](https://api.nrfcloud.com/v1/#operation/ProvisionDevices). You can use the onboarding CSV file produced by `device_credentials_installer`.

### Example
Expand Down Expand Up @@ -312,7 +312,7 @@ The target device must have the Provisioning feature enabled. A good reference o
When not using provisioning tags (with the `--provisioning-tags` argument), this script creates device credentials for use with nRF Cloud and so requires a CA certificate and the associated private key as an input.

Use the `create_ca_cert` script to create a self-signed CA certificate and keys.
Your nRF Cloud REST API key is also a required parameter. It can be found on your [User Account page](https://nrfcloud.com/#/account).
Your nRF Cloud REST API key is also a required parameter. It can be found on your [User Account page](https://app.nrfcloud.com/#/account).
Use `--help` for additional parameter information.

### Examples
Expand Down Expand Up @@ -387,7 +387,7 @@ Use the `nrf_cloud_device_mgmt` script to create FOTA (Firmware Over-The-Air) up

* On boarded device to nRF Cloud. Follow the steps outlined in the [Device Credentials Installer](#device-credentials-installer) and [nRF Cloud Device Onboarding](#nrf-cloud-device-onboarding) sections, which include generating device credentials, programming them to the device, and completing the onboarding process.
* Enable FOTA in your project by referring to the following design examples: [nRF Cloud REST FOTA Sample](https://github.com/nrfconnect/sdk-nrf/tree/main/samples/cellular/nrf_cloud_rest_fota) and [nRF Cloud Multi-Service Sample](https://github.com/nrfconnect/sdk-nrf/tree/main/samples/cellular/nrf_cloud_multi_service).
* An **nRF Cloud API key** is required. You can find your API key on your [nRF Cloud User Account page](https://nrfcloud.com/#/account).
* An **nRF Cloud API key** is required. You can find your API key on your [nRF Cloud User Account page](https://app.nrfcloud.com/#/account).

### Execution Modes

Expand All @@ -407,7 +407,7 @@ The script can run in two modes:
### Applying the FOTA Job

* **Default Behavior:** By default, the script automatically attempts to apply the created FOTA job to the target device(s).
* **Manual Application:** To create the job definition without immediately applying it, add the `--defer-apply` flag. You can then manually trigger the update later using the [ApplyFOTAJob](https://api.nrfcloud.com/v1#tag/FOTA-Jobs/operation/ApplyFOTAJob) API endpoint or directly from the [Firmware Updates dashboard](https://nrfcloud.com/#/updates-dashboard) on nRF Cloud.
* **Manual Application:** To create the job definition without immediately applying it, add the `--defer-apply` flag. You can then manually trigger the update later using the [ApplyFOTAJob](https://api.nrfcloud.com/v1#tag/FOTA-Jobs/operation/ApplyFOTAJob) API endpoint or directly from the [Firmware Updates dashboard](https://app.nrfcloud.com/#/updates-dashboard) on nRF Cloud.

### Output

Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Run the following command to use this package as a dependency:
## Requirements

1. Create an account in [nrfcloud.com](https://nrfcloud.com).
2. Retrieve your API key. You can find it in your [nRF Cloud User Account page](https://nrfcloud.com/#/account). Note that if you are part of multiple teams on nRF Cloud, the API key will be different for each one.
2. Retrieve your API key. You can find it in your [nRF Cloud User Account page](https://app.nrfcloud.com/#/account). Note that if you are part of multiple teams on nRF Cloud, the API key will be different for each one.
3. Depending on your goal, you'll need to configure your nRF Connect SDK project with the following libraries:

* **For basic device registration:** Enable the [AT Host library](https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/libraries/modem/at_host.html). Refer to the [AT Client sample](https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/samples/cellular/at_client/README.html) in the nRF Connect SDK for an implementation example.
Expand Down Expand Up @@ -81,7 +81,7 @@ Onboard the device to your account using the `nrf_cloud_onboard` script as follo

It is possible to install credentials on many devices in a row using the `--append` option and add the bulk `onboard.csv` to your account with the same command.

Congratulations! You have successfully registered your device to nRF Cloud, you should be able to visualize it on the [Devices panel](https://nrfcloud.com/#/devices).
Congratulations! You have successfully registered your device to nRF Cloud, you should be able to visualize it on the [Devices panel](https://app.nrfcloud.com/#/devices).

## Advanced Usage

Expand Down
4 changes: 2 additions & 2 deletions src/nrfcloud_utils/create_proxy_jwt.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,12 +19,12 @@ def parse_args(in_args):

parser.add_argument("--key", type=str, required=True,
help="Required filepath to the ES256 private key PEM (Service Key) used for JWT signing. \
Obtained from https://nrfcloud.com/#/manage-services",
Obtained from https://app.nrfcloud.com/#/manage-services",
default=None)

parser.add_argument("--team-id", type=str, required=True,
help="Required nRF Cloud Team ID; added to the aud claim. \
Your Team ID can be found at https://nrfcloud.com/#/teams",
Your Team ID can be found at https://app.nrfcloud.com/#/teams",
default=None)

parser.add_argument("--dev-id", type=str, required=False,
Expand Down