[Simulation] Add energy analysis with exporting commands and chart visualization #235

Vinggui · 2022-03-23T00:40:12Z

Contribution description

This PR adds energy analysis (including charts), transmission timings, and collision analysis support to the OTNS. It is, however, compatible with the current version of the Openthread/Openthread simulated device.

This PR also introduces:

A new CLI called energy save [output name], allowing the user to store the energy results obtained out of their simulation;
A new button called "Open Charts" in the Action bar of the web interface. It opens a new browser tab which does not interfere with the PIXI interface. This tab contains
3 charts: Energy consumption history, energy consumption by radio state and node ID, and power consumption.

This energy simulation is based on the STM32WB55rg at 3.3V:

	RadioDisabledConsumption float64 = 0.00011 //To be confirmed
	RadioTxConsumption       float64 = 0.01716 //5.2 mA
	RadioRxConsumption       float64 = 0.01485 //4.5 mA
	RadioIdleConsumption     float64 = 0.01485 //4.5 mA

Main modifications

A new energy analysis module (Go);
An extended PROTO service that provides a streaming API to the new char tab;
A new HTML file using Chart.js and the extended gRPC service;
Some re-wiring on the existent go modules, to include the energy analysis module;
New event type providing TxDone callbacks that consider transmission times to the simulated device;
New style of simplelogger.Debugf "status push", showing the simulated time;
New event type that allows simulated devices to do Clear Channel Assessment (with future possibility to provide scanning and RSSI model into the simulation);
New event type eventTypeRadioComm = 6 that will substitute eventTypeRadioReceived = 1. At the moment, both types are used to keep compatibility between the new changes of PR #7500 and the current OpenThread version, respectively.

Needs check/review

I believe that the modifications should not impact any other OTNS' functionalities, but I could not yet test some of them, for example:

Real devices integrated to the simulator;
Replay;
Python commands.

If you please have easy access to it, send me feedback.

Requirements

None (if intended to be used with current Openthread repository). But, there is another PR #7500 in Openthread repository that allows all the new features in the simulation to work.

Testing procedure

Just install OTNS the same way as before, using the "OTNS=1" for the building parameter.

To obtain the energy results, just use the command energy save, but if you want a specific name for the files, use energy save "name"

lgtm-com · 2022-03-23T00:46:08Z

This pull request introduces 3 alerts and fixes 1 when merging 1e0f326 into 941d6e2 - view on LGTM.com

new alerts:

2 for Unused variable, import, function or class
1 for Reflected cross-site scripting

fixed alerts:

1 for Incorrect conversion between integer types

lgtm-com · 2022-03-23T02:14:47Z

This pull request introduces 1 alert and fixes 1 when merging 50adc82 into 941d6e2 - view on LGTM.com

new alerts:

1 for Reflected cross-site scripting

fixed alerts:

1 for Incorrect conversion between integer types

lgtm-com · 2022-03-29T04:21:56Z

This pull request introduces 1 alert and fixes 1 when merging 7258257 into 941d6e2 - view on LGTM.com

new alerts:

1 for Reflected cross-site scripting

fixed alerts:

1 for Incorrect conversion between integer types

simonlingoogle

Did a very brief review of the code. The overall structure seems good to me.

One major concern might be why do we need an extra streaming RPC for energy report?
I wonder if Visualize RPC should also send energy-related events.

cli/ast.go

simonlingoogle · 2022-03-30T14:13:35Z

dispatcher/dispatcher.go

@@ -230,7 +232,7 @@ loop:
 		select {
 		case f := <-d.taskChan:
 			f()
-			break
+			// break //ineffective break statement. Did you mean to break out of the outer loop?


Yes, it's a redundant break.
I think it's added to be more readable for C/C++ readers.

I agree, but I was fixing some warnings with it. I don't mind leaving, but for that C/C++ readers, a simple comment like that also solves the issue, without adding warnings.

will it cause warning ?

I checked again, and those warnings were actually pointed by VS Code. I believe that VS Code got it right anyway, a commented break is as useful and visually representative as an unnecessary break.

web/site/templates/chartsViewer.html

web/site/site.go

web/site/js/chartsViewer.js

visualize/nopVisualizer.go

visualize/multi/multiVisualizer.go

simonlingoogle · 2022-03-30T14:20:56Z

visualize/grpc/pb/visualize_grpc.proto

@@ -217,6 +231,7 @@ service VisualizeGrpcService {
    //    rpc Echo (EchoRequest) returns (EchoResponse);
    rpc Visualize (VisualizeRequest) returns (stream VisualizeEvent);
    rpc Command (CommandRequest) returns (CommandResponse);
+    rpc EnergyReport (VisualizeRequest) returns (stream NetworkEnergyEvent);


Maybe we don't need an extra GRPC streaming interface? Visualize should just work?

One major concern might be why do we need an extra streaming RPC for energy report? I wonder if Visualize RPC should also send energy-related events.

I decided to create a new RPC stream to detach the streamed objects from what is used by the visualize.js. It looks to me that splitting both streams is the correct approach to what this "API" is serving each clients' necessity.

Not only that, but visualizer.js filters each streamed object for every callback it receives. Using the same streaming interface would increase unnecessary filtering in both visualizer.js and energyViewer.js.

I don't see a reason to merge them together, but please let me know if I did not evaluate it correctly.

visualize/grpc/grpcVisualizer.go

lgtm-com · 2022-03-30T22:06:26Z

This pull request introduces 1 alert and fixes 1 when merging 3e23d29 into 8da999e - view on LGTM.com

new alerts:

1 for Reflected cross-site scripting

fixed alerts:

1 for Incorrect conversion between integer types

lgtm-com · 2022-03-30T23:50:49Z

This pull request introduces 1 alert and fixes 1 when merging ad023ac into 8da999e - view on LGTM.com

new alerts:

1 for Reflected cross-site scripting

fixed alerts:

1 for Incorrect conversion between integer types

lgtm-com · 2022-03-31T07:44:17Z

This pull request introduces 1 alert and fixes 1 when merging c642beb into 8da999e - view on LGTM.com

new alerts:

1 for Reflected cross-site scripting

fixed alerts:

1 for Incorrect conversion between integer types

Vinggui · 2022-03-31T07:53:04Z

I realized one big problem in this simulated energy measurements: the transmission times are not simulated. So, we don't get the right timing spent on transmission state.

Update:
@simonlingoogle, I got transmission timing working, and collision model implemented too. Please, consider reviewing again both PR #7500 and this one. I think I made a good contribution here.

codecov-commenter · 2022-05-07T18:26:46Z

Codecov Report

Merging #235 (a7729bb) into main (7d96f58) will decrease coverage by 3.80%.
The diff coverage is 11.31%.

@@            Coverage Diff             @@
##             main     #235      +/-   ##
==========================================
- Coverage   49.93%   46.12%   -3.81%     
==========================================
  Files          38       40       +2     
  Lines        4604     5058     +454     
==========================================
+ Hits         2299     2333      +34     
- Misses       2123     2535     +412     
- Partials      182      190       +8

Impacted Files	Coverage Δ
cli/CmdRunner.go	`22.62% <0.00%> (-0.51%)`	⬇️
cli/ast.go	`66.66% <ø> (ø)`
types/types.go	`65.38% <ø> (ø)`
visualize/grpc/grpcStream.go	`50.00% <0.00%> (-50.00%)`	⬇️
visualize/multi/multiVisualizer.go	`0.00% <0.00%> (ø)`
visualize/nopVisualizer.go	`50.00% <ø> (ø)`
visualize/types.go	`17.39% <ø> (ø)`
web/site/bindata.go	`99.01% <ø> (+0.01%)`	⬆️
visualize/grpc/pb/visualize_grpc.pb.go	`18.00% <1.92%> (-1.42%)`	⬇️
dispatcher/dispatcher.go	`48.22% <5.26%> (-8.88%)`	⬇️
... and 10 more

lgtm-com · 2022-05-07T18:27:57Z

This pull request introduces 2 alerts when merging eb6d545 into 8b7655f - view on LGTM.com

new alerts:

1 for Incorrect conversion between integer types
1 for Reflected cross-site scripting

lgtm-com · 2022-05-07T19:18:33Z

This pull request fixes 1 alert when merging 0bc5318 into 8b7655f - view on LGTM.com

fixed alerts:

1 for Reflected cross-site scripting

lgtm-com · 2022-05-09T19:52:34Z

This pull request fixes 1 alert when merging a7729bb into 7d96f58 - view on LGTM.com

fixed alerts:

1 for Reflected cross-site scripting

lgtm-com · 2022-06-30T16:58:38Z

This pull request fixes 1 alert when merging 31e9e06 into 4616010 - view on LGTM.com

fixed alerts:

1 for Reflected cross-site scripting

lgtm-com · 2022-09-19T17:44:49Z

This pull request fixes 1 alert when merging c3a61f8 into 0ab7444 - view on LGTM.com

fixed alerts:

1 for Reflected cross-site scripting

lgtm-com · 2022-09-19T19:43:30Z

This pull request fixes 1 alert when merging ae7a872 into 0ab7444 - view on LGTM.com

fixed alerts:

1 for Reflected cross-site scripting

This comment was marked as resolved.

Sign in to view

Vinggui mentioned this pull request Mar 28, 2022

[otns] emit radio state to simulator, CCA, and transmission duration openthread/openthread#7500

Closed

simonlingoogle reviewed Mar 30, 2022

View reviewed changes

Vinggui changed the title ~~Added energy analysis to the simulator, with exporting commands and chart visualization~~ [Simulation] Add energy analysis with exporting commands and chart visualization May 5, 2022

Vinggui requested a review from simonlingoogle May 5, 2022 20:28

Vinggui mentioned this pull request May 8, 2022

[Stress-test] Network Formation Test failing with excessively high timing values #273

Closed

feat: add radio states and energy consumption

f2d7703

This was referenced Sep 12, 2022

[Energy] Add radio states and energy consumption - Part 3 of RTEA #359

Open

[Energy] Add reports of radio state to the OTNS - Part 4 of RTEA openthread/openthread#8152

Closed

feat: add timing support for events

70fbbb2

This was referenced Sep 14, 2022

[Energy] Add support to timed-transmission events - Part 5 of RTEA #362

Open

[Energy] Add timed-events to simulated devices - Part 6 of RTEA openthread/openthread#8165

Closed

feat: add collision detection and CCA support

b2055e9

Vinggui mentioned this pull request Sep 15, 2022

[Collision] Add collision detection and CCA support - Part 7 of RTEA #363

Open

feat: add gRPC with energy data to be used by the web

66919bc

Vinggui mentioned this pull request Sep 15, 2022

[web] Add gRPC features to provide data to the web - Part 9 of RTEA #365

Open

Vinicius Guimaraes added 3 commits September 15, 2022 08:40

doc: fix copyright year

66f920b

doc: fix copyright year

8bc45b5

feat: add energy charts to the web view

9bade00

Vinggui mentioned this pull request Sep 15, 2022

[web] Add energy charts to the web interface - Part 10 of RTEA #366

Open

fix: remove functions for the previous OT device

ae7a872

This was referenced Sep 15, 2022

[Energy] Remove previous OT device support - Part 11 of RTEA #367

Open

[Energy] Add CCA support to simulated devices of OTNS - Part 8 of RTEA openthread/openthread#8173

Closed

Vinggui marked this pull request as draft September 19, 2022 18:25

Vinggui force-pushed the main branch from c3a61f8 to ae7a872 Compare September 19, 2022 19:22

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Simulation] Add energy analysis with exporting commands and chart visualization #235

[Simulation] Add energy analysis with exporting commands and chart visualization #235

Vinggui commented Mar 23, 2022 •

edited

Loading

lgtm-com bot commented Mar 23, 2022

lgtm-com bot commented Mar 23, 2022

This comment was marked as resolved.

lgtm-com bot commented Mar 29, 2022

simonlingoogle left a comment

simonlingoogle Mar 30, 2022

Vinggui Mar 30, 2022

simonlingoogle Mar 31, 2022

Vinggui Mar 31, 2022

simonlingoogle Mar 30, 2022

Vinggui Mar 30, 2022 •

edited

Loading

lgtm-com bot commented Mar 30, 2022

lgtm-com bot commented Mar 30, 2022

lgtm-com bot commented Mar 31, 2022

Vinggui commented Mar 31, 2022 •

edited

Loading

codecov-commenter commented May 7, 2022 •

edited

Loading

lgtm-com bot commented May 7, 2022

lgtm-com bot commented May 7, 2022

lgtm-com bot commented May 9, 2022

lgtm-com bot commented Jun 30, 2022

lgtm-com bot commented Sep 19, 2022

lgtm-com bot commented Sep 19, 2022

[Simulation] Add energy analysis with exporting commands and chart visualization #235

Are you sure you want to change the base?

[Simulation] Add energy analysis with exporting commands and chart visualization #235

Conversation

Vinggui commented Mar 23, 2022 • edited Loading

Contribution description

Main modifications

Needs check/review

Requirements

Testing procedure

lgtm-com bot commented Mar 23, 2022

lgtm-com bot commented Mar 23, 2022

This comment was marked as resolved.

lgtm-com bot commented Mar 29, 2022

simonlingoogle left a comment

Choose a reason for hiding this comment

simonlingoogle Mar 30, 2022

Choose a reason for hiding this comment

Vinggui Mar 30, 2022

Choose a reason for hiding this comment

simonlingoogle Mar 31, 2022

Choose a reason for hiding this comment

Vinggui Mar 31, 2022

Choose a reason for hiding this comment

simonlingoogle Mar 30, 2022

Choose a reason for hiding this comment

Vinggui Mar 30, 2022 • edited Loading

Choose a reason for hiding this comment

lgtm-com bot commented Mar 30, 2022

lgtm-com bot commented Mar 30, 2022

lgtm-com bot commented Mar 31, 2022

Vinggui commented Mar 31, 2022 • edited Loading

codecov-commenter commented May 7, 2022 • edited Loading

Codecov Report

lgtm-com bot commented May 7, 2022

lgtm-com bot commented May 7, 2022

lgtm-com bot commented May 9, 2022

lgtm-com bot commented Jun 30, 2022

lgtm-com bot commented Sep 19, 2022

lgtm-com bot commented Sep 19, 2022

Vinggui commented Mar 23, 2022 •

edited

Loading

Vinggui Mar 30, 2022 •

edited

Loading

Vinggui commented Mar 31, 2022 •

edited

Loading

codecov-commenter commented May 7, 2022 •

edited

Loading