search

arduino / nicla-sense-me-fw

Arduino Nicla Sense ME resources (libraries, bootloader, host pc utilities)
GNU Affero General Public License v3.0
46 stars 27 forks source link

Add missing documentation #113

Closed sebromero closed 10 months ago

sebromero commented 11 months ago

Description

Add documentation for magic numbers.

Pull request type

[ ] Fix
[x] Refactor
[ ] Target update
[ ] Functionality change
[ ] Breaking change
github-actions[bot] commented 11 months ago

Memory usage change @ 2801bb94891c94c677ec3d00c49996b805a2e6c3

Board flash % RAM for global variables %
arduino:mbed_nicla:nicla_sense 0 - 0 0.0 - 0.0 0 - 0 0.0 - 0.0
arduino:mbed_portenta:envie_m7 N/A N/A N/A N/A
arduino:samd:mkrgsm1400 0 - 0 0.0 - 0.0 0 - 0 0.0 - 0.0
arduino:samd:mkrnb1500 0 - 0 0.0 - 0.0 0 - 0 0.0 - 0.0
arduino:samd:mkrwan1310 0 - 0 0.0 - 0.0 0 - 0 0.0 - 0.0
arduino:samd:mkrwifi1010 0 - 0 0.0 - 0.0 0 - 0 0.0 - 0.0
arduino:samd:mkrzero 0 - 0 0.0 - 0.0 0 - 0 0.0 - 0.0
Click for full report table Board|`Arduino_BHY2/examples/App`
flash|%|`Arduino_BHY2/examples/App`
RAM for global variables|%|`Arduino_BHY2/examples/AppLowDelay`
flash|%|`Arduino_BHY2/examples/AppLowDelay`
RAM for global variables|%|`Arduino_BHY2/examples/BHYFirmwareUpdate`
flash|%|`Arduino_BHY2/examples/BHYFirmwareUpdate`
RAM for global variables|%|`Arduino_BHY2/examples/BSEC2GasScannerClassify`
flash|%|`Arduino_BHY2/examples/BSEC2GasScannerClassify`
RAM for global variables|%|`Arduino_BHY2/examples/BSEC2GasScannerCollectData`
flash|%|`Arduino_BHY2/examples/BSEC2GasScannerCollectData`
RAM for global variables|%|`Arduino_BHY2/examples/DataHarvester`
flash|%|`Arduino_BHY2/examples/DataHarvester`
RAM for global variables|%|`Arduino_BHY2/examples/Fail_Safe_flasher`
flash|%|`Arduino_BHY2/examples/Fail_Safe_flasher`
RAM for global variables|%|`Arduino_BHY2/examples/ReadSensorConfiguration`
flash|%|`Arduino_BHY2/examples/ReadSensorConfiguration`
RAM for global variables|%|`Arduino_BHY2/examples/ShowSensorList`
flash|%|`Arduino_BHY2/examples/ShowSensorList`
RAM for global variables|%|`Arduino_BHY2/examples/Standalone`
flash|%|`Arduino_BHY2/examples/Standalone`
RAM for global variables|%|`Arduino_BHY2/examples/StandaloneFlashStorage`
flash|%|`Arduino_BHY2/examples/StandaloneFlashStorage`
RAM for global variables|%|`Arduino_BHY2Host/examples/Accelerometer`
flash|%|`Arduino_BHY2Host/examples/Accelerometer`
RAM for global variables|%|`Arduino_BHY2Host/examples/Orientation`
flash|%|`Arduino_BHY2Host/examples/Orientation`
RAM for global variables|%|`Arduino_BHY2Host/examples/Temperature`
flash|%|`Arduino_BHY2Host/examples/Temperature`
RAM for global variables|%|`Arduino_BHY2Host/examples/Nicla_IoT_Bridge`
flash|%|`Arduino_BHY2Host/examples/Nicla_IoT_Bridge`
RAM for global variables|%|`Arduino_BHY2Host/examples/Portenta_BLE_Bridge`
flash|%|`Arduino_BHY2Host/examples/Portenta_BLE_Bridge`
RAM for global variables|% -|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|- `arduino:mbed_nicla:nicla_sense`|0|0.0|0|0.0|0|0.0|0|0.0|0|0.0|0|0.0|0|0.0|0|0.0|0|0.0|0|0.0|0|0.0|0|0.0|0|0.0|0|0.0|0|0.0|0|0.0|0|0.0|0|0.0|0|0.0|0|0.0|0|0.0|0|0.0 `arduino:mbed_portenta:envie_m7`|||||||||||||||||||||||||||||||||||||||||||||N/A|N/A|N/A|N/A|N/A|N/A|N/A|N/A|N/A|N/A|N/A|N/A|N/A|N/A|N/A|N/A|N/A|N/A|N/A|N/A `arduino:samd:mkrgsm1400`|||||||||||||||||||||||||||||||||||||||||||||0|0.0|0|0.0|0|0.0|0|0.0|0|0.0|0|0.0|||||||| `arduino:samd:mkrnb1500`|||||||||||||||||||||||||||||||||||||||||||||0|0.0|0|0.0|0|0.0|0|0.0|0|0.0|0|0.0|||||||| `arduino:samd:mkrwan1310`|||||||||||||||||||||||||||||||||||||||||||||0|0.0|0|0.0|0|0.0|0|0.0|0|0.0|0|0.0|||||||| `arduino:samd:mkrwifi1010`|||||||||||||||||||||||||||||||||||||||||||||0|0.0|0|0.0|0|0.0|0|0.0|0|0.0|0|0.0|0|0.0|0|0.0|||| `arduino:samd:mkrzero`|||||||||||||||||||||||||||||||||||||||||||||0|0.0|0|0.0|0|0.0|0|0.0|0|0.0|0|0.0||||||||
Click for full report CSV ``` Board,Arduino_BHY2/examples/App
flash,%,Arduino_BHY2/examples/App
RAM for global variables,%,Arduino_BHY2/examples/AppLowDelay
flash,%,Arduino_BHY2/examples/AppLowDelay
RAM for global variables,%,Arduino_BHY2/examples/BHYFirmwareUpdate
flash,%,Arduino_BHY2/examples/BHYFirmwareUpdate
RAM for global variables,%,Arduino_BHY2/examples/BSEC2GasScannerClassify
flash,%,Arduino_BHY2/examples/BSEC2GasScannerClassify
RAM for global variables,%,Arduino_BHY2/examples/BSEC2GasScannerCollectData
flash,%,Arduino_BHY2/examples/BSEC2GasScannerCollectData
RAM for global variables,%,Arduino_BHY2/examples/DataHarvester
flash,%,Arduino_BHY2/examples/DataHarvester
RAM for global variables,%,Arduino_BHY2/examples/Fail_Safe_flasher
flash,%,Arduino_BHY2/examples/Fail_Safe_flasher
RAM for global variables,%,Arduino_BHY2/examples/ReadSensorConfiguration
flash,%,Arduino_BHY2/examples/ReadSensorConfiguration
RAM for global variables,%,Arduino_BHY2/examples/ShowSensorList
flash,%,Arduino_BHY2/examples/ShowSensorList
RAM for global variables,%,Arduino_BHY2/examples/Standalone
flash,%,Arduino_BHY2/examples/Standalone
RAM for global variables,%,Arduino_BHY2/examples/StandaloneFlashStorage
flash,%,Arduino_BHY2/examples/StandaloneFlashStorage
RAM for global variables,%,Arduino_BHY2Host/examples/Accelerometer
flash,%,Arduino_BHY2Host/examples/Accelerometer
RAM for global variables,%,Arduino_BHY2Host/examples/Orientation
flash,%,Arduino_BHY2Host/examples/Orientation
RAM for global variables,%,Arduino_BHY2Host/examples/Temperature
flash,%,Arduino_BHY2Host/examples/Temperature
RAM for global variables,%,Arduino_BHY2Host/examples/Nicla_IoT_Bridge
flash,%,Arduino_BHY2Host/examples/Nicla_IoT_Bridge
RAM for global variables,%,Arduino_BHY2Host/examples/Portenta_BLE_Bridge
flash,%,Arduino_BHY2Host/examples/Portenta_BLE_Bridge
RAM for global variables,% arduino:mbed_nicla:nicla_sense,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0 arduino:mbed_portenta:envie_m7,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A arduino:samd:mkrgsm1400,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,,,,,,,, arduino:samd:mkrnb1500,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,,,,,,,, arduino:samd:mkrwan1310,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,,,,,,,, arduino:samd:mkrwifi1010,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,,,, arduino:samd:mkrzero,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,,,,,,,, ```