Trying to use the REST API to modify available fields in an nrf cloud device configuration

RE: Trying to use the REST API to modify available fields in an nrf cloud device configuration

JackW — Wed, 31 Jan 2024 18:57:30 GMT

OK, that worked. Thanks

RE: Trying to use the REST API to modify available fields in an nrf cloud device configuration

JackW — Wed, 31 Jan 2024 18:17:24 GMT

OK, so to change the 'reported' config would I use the following in postman:

RE: Trying to use the REST API to modify available fields in an nrf cloud device configuration

egood — Wed, 31 Jan 2024 17:59:52 GMT

You can update the desired and reported sections through postman and REST APIs, we do this frequently with our devices. What may be happening is you device firmware may be updating the reported section with the value you are trying to remove? It's possibly you are removing it via the API but then the device is adding it back in. I would try shutting your device off and running the API via postman and see if it sticks.

RE: Trying to use the REST API to modify available fields in an nrf cloud device configuration

JackW — Wed, 31 Jan 2024 16:51:29 GMT

Yeah, I'd like to be able to set the reported config item to null but I can't find a way to do that. I can only set the sesired config item to null. The way I understand it is that the user changes the desired config and that then updates the reported config.

If I use Postman to send a config change via the REST API, that only goes to the desired config.

If I use the nrf Cloud to attempt to change config, that too only gives me access to the desired config, not the reported.

Is there any way to directly change the reported config?

RE: Trying to use the REST API to modify available fields in an nrf cloud device configuration

justin — Wed, 31 Jan 2024 01:55:21 GMT

the device is responsible for maintaining the reported state.

i do not believe AWS generates delta events for cleared items.

you will need to set the config item to null for the reported section too.

RE: Trying to use the REST API to modify available fields in an nrf cloud device configuration

JackW — Mon, 29 Jan 2024 18:26:46 GMT

Yes, I'm aware of the difference between desired and reported.

The device has reconnected with the cloud multiple times over the past 24 hours, and the reported state still has the extra field that was removed from the desired state.

So for some reason, that change isn't propagating through to change the actual state.

Don't know why.

RE: Trying to use the REST API to modify available fields in an nrf cloud device configuration

dejans — Mon, 29 Jan 2024 12:51:42 GMT

Hi,

As you can read in nRF Cloud REST API blog, the “reported” object shows the state of the device when it last published its state to the Cloud. The “desired” object shows updates that have not been pushed to the device yet (probably because it hasn’t connected to the Cloud since the update was requested).

Best regards,
Dejan

RE: Trying to use the REST API to modify available fields in an nrf cloud device configuration

JackW — Sun, 28 Jan 2024 21:13:17 GMT

Thanks. This fixes half my problem. I was able to delete the field from the 'desired' state, but for some reason that isn't propagating over to the 'reported' state. Here's what the confifuration looks like now:

Don't know why.

RE: Trying to use the REST API to modify available fields in an nrf cloud device configuration

egood — Sun, 28 Jan 2024 15:08:26 GMT

If you want to remove a field you can do so by calling the key you want to remove with a value of null. In your case you would want to send the following via UpdateDevieState REST API.

{
    "desired": {
        "config": {
            "phonebook": null
        }
    },
    "reported": {
        "config": {
            "phonebook": null
        }
    }
}

Note, I don't know if this field is in "desired" or "reported" so you will need to specify, I assumed you have it in both sections.

Sometime it's also nice to just start from scratch with the whole config object and then re-initialize it. In which case you can call the following:

{
    "reported": {
        "config":null
    },
    "desired": {
        "config":null
    }
}