Skip to content

[AE-197] Add new SensorIDs #1481

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

[AE-197] Add new SensorIDs #1481

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
164 changes: 87 additions & 77 deletions ...nt/hardware/06.nicla/boards/nicla-sense-me/tutorials/cheat-sheet/cheat-sheet.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -219,16 +219,16 @@ In the following section, you can see how these ID's are used in an Arduino sket
- **SensorActivity**: Use this class to handle sensors with the activity format. The activity is encoded as ID and can be retrieved from the `value` property. Use `getActivity` to get a human readable version of the activity e.g. "Walking activity started".
- **SensorBSEC**: BSEC stands for Bosch Sensortec Environmental Cluster, basically you can access the air quality (IAQ) level and it contains the following data:

| Function | Description | Data type |
| ------------ | ----------------------------------- | --------------- |
| `iaq()` | IAQ value for regular use case | unsigned 16bit |
| `iaq_s()` | IAQ value for stationary use cases | unsigned 16bit |
| `b_voc_eq()` | breath VOC equivalent (ppm) | float |
| `co2_eq()` | CO2 equivalent (ppm) [400,] | unsigned 32bit |
| `comp_t()` | compensated temperature (Celsius) | float |
| `comp_h()` | compensated humidity | float |
| `comp_g()` | compensated gas resistance (Ohms) | unsigned 32bit |
| `accuracy()` | accuracy level: [0-3] | unsigned 8bit |
| Function | Description | Data type |
|--------------|------------------------------------|----------------|
| `iaq()` | IAQ value for regular use case | unsigned 16bit |
| `iaq_s()` | IAQ value for stationary use cases | unsigned 16bit |
| `b_voc_eq()` | breath VOC equivalent (ppm) | float |
| `co2_eq()` | CO2 equivalent (ppm) [400,] | unsigned 32bit |
| `comp_t()` | compensated temperature (Celsius) | float |
| `comp_h()` | compensated humidity | float |
| `comp_g()` | compensated gas resistance (Ohms) | unsigned 32bit |
| `accuracy()` | accuracy level: [0-3] | unsigned 8bit |


Further down you can see how these objects are used in an Arduino sketch to get readings from the sensors.
Expand All @@ -237,73 +237,83 @@ Further down you can see how these objects are used in an Arduino sketch to get

The IDs to address the sensors both through ESLOV and WebBLE are as follows:

| ID | Description | SENSOR_ID MACRO | Class |
| :-----------: | :---------------------------------: | :--------------------------: | :---------------: |
| 1 | Accelerometer passthrough | SENSOR_ID_ACC_PASS | SensorXYZ |
| 3 | Accelerometer uncalibrated | SENSOR_ID_ACC_RAW | SensorXYZ |
| 4 | Accelerometer corrected | SENSOR_ID_ACC | SensorXYZ |
| 5 | Accelerometer offset | SENSOR_ID_ACC_BIAS | SensorXYZ |
| 6 | Accelerometer corrected wake up | SENSOR_ID_ACC_WU | SensorXYZ |
| 7 | Accelerometer uncalibrated wake up | SENSOR_ID_ACC_RAW_WU | SensorXYZ |
| 10 | Gyroscope passthrough | SENSOR_ID_GYRO_PASS | SensorXYZ |
| 12 | Gyroscope uncalibrated | SENSOR_ID_GYRO_RAW | SensorXYZ |
| 13 | Gyroscope corrected | SENSOR_ID_GYRO | SensorXYZ |
| 14 | Gyroscope offset | SENSOR_ID_GYRO_BIAS | SensorXYZ |
| 15 | Gyroscope wake up | SENSOR_ID_GYRO_WU | SensorXYZ |
| 16 | Gyroscope uncalibrated wake up | SENSOR_ID_GYRO_RAW_WU | SensorXYZ |
| 19 | Magnetometer passthrough | SENSOR_ID_MAG_PASS | SensorXYZ |
| 21 | Magnetometer uncalibrated | SENSOR_ID_MAG_RAW | SensorXYZ |
| 22 | Magnetometer corrected | SENSOR_ID_MAG | SensorXYZ |
| 23 | Magnetometer offset | SENSOR_ID_MAG_BIAS | SensorXYZ |
| 24 | Magnetometer wake up | SENSOR_ID_MAG_WU | SensorXYZ |
| 25 | Magnetometer uncalibrated wake up | SENSOR_ID_MAG_RAW_WU | SensorXYZ |
| 28 | Gravity vector | SENSOR_ID_GRA | SensorXYZ |
| 29 | Gravity vector wake up | SENSOR_ID_GRA_WU | SensorXYZ |
| 31 | Linear acceleration | SENSOR_ID_LACC | SensorXYZ |
| 32 | Linear acceleration wake up | SENSOR_ID_LACC_WU | SensorXYZ |
| 34 | Rotation vector | SENSOR_ID_RV | SensorQuaternion |
| 35 | Rotation vector wake up | SENSOR_ID_RV_WU | SensorQuaternion |
| 37 | Game rotation vector | SENSOR_ID_GAMERV | SensorQuaternion |
| 38 | Game rotation vector wake up | SENSOR_ID_GAMERV_WU | SensorQuaternion |
| 40 | Geomagnetic rotation vector | SENSOR_ID_GEORV | SensorQuaternion |
| 41 | Geomagnetic rotation vector wake up | SENSOR_ID_GEORV_WU | SensorQuaternion |
| 43 | Orientation | SENSOR_ID_ORI | SensorOrientation |
| 44 | Orientation wake up | SENSOR_ID_ORI_WU | SensorOrientation |
| 48 | Tilt detector | SENSOR_ID_TILT_DETECTOR | Sensor |
| 50 | Step detector | SENSOR_ID_STD | Sensor |
| 52 | Step counter | SENSOR_ID_STC | Sensor |
| 53 | Step counter wake up | SENSOR_ID_STC_WU | Sensor |
| 55 | Significant motion | SENSOR_ID_SIG | Sensor |
| 57 | Wake gesture | SENSOR_ID_WAKE_GESTURE | Sensor |
| 59 | Glance gesture | SENSOR_ID_GLANCE_GESTURE | Sensor |
| 61 | Pickup gesture | SENSOR_ID_PICKUP_GESTURE | Sensor |
| 63 | Activity recognition | SENSOR_ID_AR | SensorActivity |
| 67 | Wrist tilt gesture | SENSOR_ID_WRIST_TILT_GESTURE | Sensor |
| 69 | Device orientation | SENSOR_ID_DEVICE_ORI | SensorOrientation |
| 70 | Device orientation wake up | SENSOR_ID_DEVICE_ORI_WU | Sensor |
| 75 | Stationary detect | SENSOR_ID_STATIONARY_DET | Sensor |
| 77 | Motion detect | SENSOR_ID_MOTION_DET | Sensor |
| 91 | Accelerometer offset wake up | SENSOR_ID_ACC_BIAS_WU | SensorXYZ |
| 92 | Gyroscope offset wake up | SENSOR_ID_GYRO_BIAS_WU | SensorXYZ |
| 93 | Magnetometer offset wake up | SENSOR_ID_MAG_BIAS_WU | SensorXYZ |
| 94 | Step detector wake up | SENSOR_ID_STD_WU | Sensor |
| 115 | BSEC data | SENSOR_ID_BSEC | SensorBSEC |
| 128 | Temperature | SENSOR_ID_TEMP | Sensor |
| 129 | Barometer | SENSOR_ID_BARO | Sensor |
| 130 | Humidity | SENSOR_ID_HUM | Sensor |
| 131 | Gas | SENSOR_ID_GAS | Sensor |
| 132 | Temperature wake up | SENSOR_ID_TEMP_WU | Sensor |
| 133 | Barometer wake up | SENSOR_ID_BARO_WU | Sensor |
| 134 | Humidity wake up | SENSOR_ID_HUM_WU | Sensor |
| 135 | Gas wake up | SENSOR_ID_GAS_WU | Sensor |
| 136 | Hardware Step counter | SENSOR_ID_STC_HW | Sensor |
| 137 | Hardware Step detector | SENSOR_ID_STD_HW | Sensor |
| 138 | Hardware Significant motion | SENSOR_ID_SIG_HW | Sensor |
| 139 | Hardware Step counter wake up | SENSOR_ID_STC_HW_WU | Sensor |
| 140 | Hardware Step detector wake up | SENSOR_ID_STD_HW_WU | Sensor |
| 141 | Hardware Significant motion wake up | SENSOR_ID_SIG_HW_WU | Sensor |
| 142 | Any motion | SENSOR_ID_ANY_MOTION | Sensor |
| 143 | Any motion wake up | SENSOR_ID_ANY_MOTION_WU | Sensor |
| ID | Description | SENSOR_ID MACRO | Class |
|:---:|:-----------------------------------:|:----------------------------:|:--------------------:|
| 1 | Accelerometer passthrough | SENSOR_ID_ACC_PASS | SensorXYZ |
| 3 | Accelerometer uncalibrated | SENSOR_ID_ACC_RAW | SensorXYZ |
| 4 | Accelerometer corrected | SENSOR_ID_ACC | SensorXYZ |
| 5 | Accelerometer offset | SENSOR_ID_ACC_BIAS | SensorXYZ |
| 6 | Accelerometer corrected wake up | SENSOR_ID_ACC_WU | SensorXYZ |
| 7 | Accelerometer uncalibrated wake up | SENSOR_ID_ACC_RAW_WU | SensorXYZ |
| 10 | Gyroscope passthrough | SENSOR_ID_GYRO_PASS | SensorXYZ |
| 12 | Gyroscope uncalibrated | SENSOR_ID_GYRO_RAW | SensorXYZ |
| 13 | Gyroscope corrected | SENSOR_ID_GYRO | SensorXYZ |
| 14 | Gyroscope offset | SENSOR_ID_GYRO_BIAS | SensorXYZ |
| 15 | Gyroscope wake up | SENSOR_ID_GYRO_WU | SensorXYZ |
| 16 | Gyroscope uncalibrated wake up | SENSOR_ID_GYRO_RAW_WU | SensorXYZ |
| 19 | Magnetometer passthrough | SENSOR_ID_MAG_PASS | SensorXYZ |
| 21 | Magnetometer uncalibrated | SENSOR_ID_MAG_RAW | SensorXYZ |
| 22 | Magnetometer corrected | SENSOR_ID_MAG | SensorXYZ |
| 23 | Magnetometer offset | SENSOR_ID_MAG_BIAS | SensorXYZ |
| 24 | Magnetometer wake up | SENSOR_ID_MAG_WU | SensorXYZ |
| 25 | Magnetometer uncalibrated wake up | SENSOR_ID_MAG_RAW_WU | SensorXYZ |
| 28 | Gravity vector | SENSOR_ID_GRA | SensorXYZ |
| 29 | Gravity vector wake up | SENSOR_ID_GRA_WU | SensorXYZ |
| 31 | Linear acceleration | SENSOR_ID_LACC | SensorXYZ |
| 32 | Linear acceleration wake up | SENSOR_ID_LACC_WU | SensorXYZ |
| 34 | Rotation vector | SENSOR_ID_RV | SensorQuaternion |
| 35 | Rotation vector wake up | SENSOR_ID_RV_WU | SensorQuaternion |
| 37 | Game rotation vector | SENSOR_ID_GAMERV | SensorQuaternion |
| 38 | Game rotation vector wake up | SENSOR_ID_GAMERV_WU | SensorQuaternion |
| 40 | Geomagnetic rotation vector | SENSOR_ID_GEORV | SensorQuaternion |
| 41 | Geomagnetic rotation vector wake up | SENSOR_ID_GEORV_WU | SensorQuaternion |
| 43 | Orientation | SENSOR_ID_ORI | SensorOrientation |
| 44 | Orientation wake up | SENSOR_ID_ORI_WU | SensorOrientation |
| 48 | Tilt detector | SENSOR_ID_TILT_DETECTOR | Sensor |
| 50 | Step detector | SENSOR_ID_STD | Sensor |
| 52 | Step counter | SENSOR_ID_STC | Sensor |
| 53 | Step counter wake up | SENSOR_ID_STC_WU | Sensor |
| 55 | Significant motion | SENSOR_ID_SIG | Sensor |
| 57 | Wake gesture | SENSOR_ID_WAKE_GESTURE | Sensor |
| 59 | Glance gesture | SENSOR_ID_GLANCE_GESTURE | Sensor |
| 61 | Pickup gesture | SENSOR_ID_PICKUP_GESTURE | Sensor |
| 63 | Activity recognition | SENSOR_ID_AR | SensorActivity |
| 67 | Wrist tilt gesture | SENSOR_ID_WRIST_TILT_GESTURE | Sensor |
| 69 | Device orientation | SENSOR_ID_DEVICE_ORI | SensorOrientation |
| 70 | Device orientation wake up | SENSOR_ID_DEVICE_ORI_WU | Sensor |
| 75 | Stationary detect | SENSOR_ID_STATIONARY_DET | Sensor |
| 77 | Motion detect | SENSOR_ID_MOTION_DET | Sensor |
| 91 | Accelerometer offset wake up | SENSOR_ID_ACC_BIAS_WU | SensorXYZ |
| 92 | Gyroscope offset wake up | SENSOR_ID_GYRO_BIAS_WU | SensorXYZ |
| 93 | Magnetometer offset wake up | SENSOR_ID_MAG_BIAS_WU | SensorXYZ |
| 94 | Step detector wake up | SENSOR_ID_STD_WU | Sensor |
| 115 | BSEC data | SENSOR_ID_BSEC | SensorBSEC |
| 128 | Temperature | SENSOR_ID_TEMP | Sensor |
| 129 | Barometer | SENSOR_ID_BARO | Sensor |
| 130 | Humidity | SENSOR_ID_HUM | Sensor |
| 131 | Gas | SENSOR_ID_GAS | Sensor |
| 132 | Temperature wake up | SENSOR_ID_TEMP_WU | Sensor |
| 133 | Barometer wake up | SENSOR_ID_BARO_WU | Sensor |
| 134 | Humidity wake up | SENSOR_ID_HUM_WU | Sensor |
| 135 | Gas wake up | SENSOR_ID_GAS_WU | Sensor |
| 136 | Hardware Step counter | SENSOR_ID_STC_HW | Sensor |
| 137 | Hardware Step detector | SENSOR_ID_STD_HW | Sensor |
| 138 | Hardware Significant motion | SENSOR_ID_SIG_HW | Sensor |
| 139 | Hardware Step counter wake up | SENSOR_ID_STC_HW_WU | Sensor |
| 140 | Hardware Step detector wake up | SENSOR_ID_STD_HW_WU | Sensor |
| 141 | Hardware Significant motion wake up | SENSOR_ID_SIG_HW_WU | Sensor |
| 142 | Any motion | SENSOR_ID_ANY_MOTION | Sensor |
| 143 | Any motion wake up | SENSOR_ID_ANY_MOTION_WU | Sensor |
| 112 | KLIO | SENSOR_ID_KLIO | SensorBSEC2 |
| 113 | PDR | SENSOR_ID_PDR | SensorBSEC2 |
| 114 | SWIM | SENSOR_ID_SWIM | SensorBSEC2 |
| 116 | BSEC 2.x raw data collector | SENSOR_ID_BSEC2_COLLECTOR | SensorBSEC2Collector |
| 117 | BSEC 2.x gas classifier | SENSOR_ID_BSEC2 | SensorBSEC2 |
| 120 | HMC | SENSOR_ID_HMC | SensorBSEC2 |
| 121 | OC | SENSOR_ID_OC | SensorBSEC2 |
| 122 | NOC | SENSOR_ID_NOC | SensorBSEC2 |
| 123 | OCE | SENSOR_ID_OCE | SensorBSEC2 |
| 124 | NOCE | SENSOR_ID_NOCE | SensorBSEC2 |



Expand Down