Reports

This section provides descriptions of reports transmitted via the Report characteristic in the ANURA Vibration Sensing Service.

List of Report Types

A list of all opcodes is detailed in the table below. See the respective sub-section for details on each opcode.

AVSS Report Types

Value	Report Type	Description
1	Reserved	Reserved for future use.
2	Snippet Report	Acceleration waveform data acquired on a pre-determined schedule.
3	Aggregates Report	Signal statistics/properties calculated from the acceleration signal.
4	Health Report	Health report from the sensor.
5	Settings Report	Current and/or pending settings.
6	Capture Report	Acceleration waveform data acquired when triggered by an asynchronous event.
7	Throughput Report	Meaningless report generated for testing throughput.

Snippet Report

The Snippet Reports contain acceleration waveform data acquired on a pre-determined schedule. The reports consist of a CBOR-encoded map, with fields detailed in the table below.

Snippet Report Fields

Key	Field	Type	Description
0	Start Time	int	Start time of the snippet in nanoseconds.
1	Sample Rate	float	Sample rate in Hz as measured by the sensor.
2	Range	int	Full scale range in units of g.
3	Samples	dict	A dictionary mapping axis indices (integers) to sample data (byte strings). The axis indices are assigned as follows: 0 for X, 1 for Y, and 2 for Z. The sample data is encoded as a packed array of 16-bit signed integers, in little endian byte order.

Aggregates Report

The Aggregates Report provides statistical data and properties derived from the acceleration signal. All fields in the Aggregates Report are optional and may be omitted. Only parameters that are enabled in the sensor settings are included in the report.

The report consists of a CBOR-encoded map, with fields detailed in the table below.

Aggregates Report Fields

Key	Field	Type	Description
0	Acceleration RMS X	float	Root mean square amplitude of acceleration along the X-axis (m/s²).
1	Acceleration RMS Y	float	Root mean square amplitude of acceleration along the Y-axis (m/s²).
2	Acceleration RMS Z	float	Root mean square amplitude of acceleration along the Z-axis (m/s²).
3	Acceleration Peak X	float	Peak amplitude of acceleration along the X-axis (m/s²).
4	Acceleration Peak Y	float	Peak amplitude of acceleration along the Y-axis (m/s²).
5	Acceleration Peak Z	float	Peak amplitude of acceleration along the Z-axis (m/s²).
6	Velocity RMS X	float	Root mean square amplitude of velocity along the X-axis (m/s).
7	Velocity RMS Y	float	Root mean square amplitude of velocity along the Y-axis (m/s).
8	Velocity RMS Z	float	Root mean square amplitude of velocity along the Z-axis (m/s).
9	Velocity Peak X	float	Peak amplitude of velocity along the X-axis (m/s).
10	Velocity Peak Y	float	Peak amplitude of velocity along the Y-axis (m/s).
11	Velocity Peak Z	float	Peak amplitude of velocity along the Z-axis (m/s).
12	Displacement PtP X	float	Peak-to-peak amplitude of displacement along the X-axis (m).
13	Displacement PtP Y	float	Peak-to-peak amplitude of displacement along the Y-axis (m).
14	Displacement PtP Z	float	Peak-to-peak amplitude of displacement along the Z-axis (m).
15	Stroke A XY	float	Planar stroke in the XY plane calculated with method A (m).
16	Stroke A YZ	float	Planar stroke in the YZ plane calculated with method A (m).
17	Stroke A XZ	float	Planar stroke in the XZ plane calculated with method A (m).
18	Stroke B XY	float	Planar stroke in the XY plane calculated with method B (m).
19	Stroke B YZ	float	Planar stroke in the YZ plane calculated with method B (m).
20	Stroke B XZ	float	Planar stroke in the XZ plane calculated with method B (m).
21	FFT Peak Frequency X	float	Frequency of the highest spectral peak along the X-axis (Hz).
22	FFT Peak Frequency Y	float	Frequency of the highest spectral peak along the Y-axis (Hz).
23	FFT Peak Frequency Z	float	Frequency of the highest spectral peak along the Z-axis (Hz).
24	Acceleration Crest Factor X	float	Crest factor of acceleration along the X-axis.
25	Acceleration Crest Factor Y	float	Crest factor of acceleration along the Y-axis.
26	Acceleration Crest Factor Z	float	Crest factor of acceleration along the Z-axis.

Health Report

The Health Report contains information regarding the operational status and health of the sensor. The reports consist of a CBOR-encoded map, with fields detailed in the table below.

Health Report Fields

Key	Field	Type	Description
0	Uptime	int	Duration the sensor has been operational since the last reboot, in seconds.
1	Reboot Count	int	Number of times the sensor has been rebooted.
2	Reset Cause	int	Reason for the last reset of the sensor.
3	Temperature	float	Internal temperature of the sensor in Celsius.
4	Battery Voltage	int	Current voltage level of the battery in millivolts.
5	RSSI	int	Received Signal Strength Indicator in dBm, representing the strength of the received radio signal.
6	Energy Harvester Voltage	int	Voltage output from the energy harvester in millivolts.
7	Clock Sync Skew [1]	float	Skew of the clock synchronization represented as a ratio.
8	Clock Sync Age [1]	int	Age of the last clock synchronization in seconds.
9	Clock Sync Difference [1]	int	Maximum clock offset in any synchronization event since last health report.

[1] (1,2,3)

This field is may be omitted.

Settings Report

The Settings Report includes information about the current and pending settings of the sensor. The reports consist of a CBOR-encoded map, with fields detailed in the table below.

Settings Report Fields

Key	Field	Type	Description
0	Current Settings	dict	A dictionary containing the current configuration settings of the sensor.
1	Pending Settings [2]	int	A dictionary containing any settings that are pending and may be applied to the sensor.

[2]

This field is may be omitted.

See Report Settings (Opcode 9) for information on how to request a Settings Report.

Capture Report

[TBD]

Throughput Report

The Throughput Report is emitted during a throughput test. It does not contain any meaningful information.