Skip to content

Commit b045030

Browse files
committed
Updated CHANGELOG.md and FEATURES.md
1 parent 8ebf601 commit b045030

File tree

2 files changed

+15
-2
lines changed

2 files changed

+15
-2
lines changed

CHANGELOG.md

+8
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,11 @@
1+
## 24-Jul-2024 (Command Response Framework and Components update)
2+
- Added support for command response framework
3+
- To demonstrate this, a simple reboot command has been added. Admins can trigger this command from the Insights dashboard (under Node's Settings tab) to reboot the device.
4+
- This feature is currently supported only for nodes claimed from the RainMaker CLI and when MQTT transport is enabled.
5+
- Updated components:
6+
- Updated the rmaker_common submodule.
7+
- Bumped up the component versions for `esp_diagnostics` and `esp_insights`.
8+
19
## 23-Feb-2024 (Added support for new metadata structure 2.0)
210

311
- This change has been introduced for better management of metrics and variables hierarchy

FEATURES.md

+7-2
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ Below are some of the features offered by ESP Insights:
88
- [Transport Sharing](#transport-sharing)
99
- [Optimising Device-Cloud Communication](#optimising-device-cloud-communication)
1010
- [Group Analytics](#group-analytics)
11+
- [Command Response](#command-response)
1112

1213
### Core Dump
1314
In case of a firmware crash, the Insights agent captures the core dump information into the flash memory and reports it to the ESP Insights cloud in the subsequent boot-up. This allows you to look at all the crash logs that the devices may be generating in the field.
@@ -123,7 +124,7 @@ esp_diag_wifi_metrics_dump();
123124
```
124125

125126
#### Custom Metrics
126-
It is fairly simple to register your own metrics as well. This can be done as:
127+
It is fairly simple to register your own metrics as well. This can be done as:
127128

128129
```
129130
/* Register a metrics to track room temperature */
@@ -180,7 +181,7 @@ As you may notice, every variable has some metadata associated with it. Some exp
180181
### Transport Sharing
181182
The Insights agent supports sending data to the cloud using HTTPS or MQTT (TLS) transport.
182183

183-
Creating a separate TLS session on the device could add to the memory consumption on the device.
184+
Creating a separate TLS session on the device could add to the memory consumption on the device.
184185
To avoid this, the Insights agent shares the transport (MQTT) with your cloud agent.
185186
Currently the RainMaker cloud agent is supported.
186187
This ensures that we reuse the socket/TLS connection without adding a connection memory overhead on your device.
@@ -222,3 +223,7 @@ You can change the interval to hour or aggregate to week or a month interval.
222223
![Group Analytics 5](docs/_static/group_analytics_5.png)
223224

224225
- List of top nodes having the most number of events and can be drilled down to category level
226+
227+
### Command Response
228+
ESP Insights leverages RainMaker's command response feature to enable the device to be controllable from the Insights dashboard.
229+
- When enabled, this feature lists options under the Node's Settings tab. These interactive options can be used to control the device. For example, an admin can remotely reboot the device, enable or disable diagnostics collection, or granularly choose to enable or disable features such as Metrics and Variables.

0 commit comments

Comments
 (0)