Important changes to repositories hosted on mbed.com
Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.
To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.
It is also possible to export all your personal repositories from the account settings page.
Dependencies: max32630fthr Adafruit_FeatherOLED USBDevice
SSMAX8614XComm Class Reference
SSMAX8614XComm Command handler class for communication with MAX30101 on SmartSensor board. More...
#include <SSMAX8614XComm.h>
Inherits SensorComm.
Public Member Functions | |
SSMAX8614XComm (USBSerial *USB, SSInterface *ssInterface, DSInterface *dsInterface) | |
SSMAX8614XComm constructor. | |
bool | parse_command (const char *cmd) |
Parses DeviceStudio-style commands. | |
int | data_report_execute (char *buf, int size) |
Fill in buffer with sensor data. | |
void | stop () |
Stop collecting data and disable sensor. | |
const char * | get_part_name () |
Get the maxim part number of the device. | |
int | selftest_max8614x () |
Execute the smart sensor self test routine. | |
int | selftest_accelerometer () |
Execute the accelerometer self test routine. | |
bool | self_test_result_evaluate (const char *message, uint8_t value) |
Evaluate the accelerometer self test routine. | |
void | comm_init (MaximSensor *s) |
Initializer for SensorComm. | |
const char * | get_type () |
Get the type of the sensor. | |
virtual const char * | get_algo_ver () |
Get the maxim algorithm version of the sensor. | |
int | get_part_info (uint8_t *part_id, uint8_t *part_rev) |
Get the id and revision of the part. | |
bool | is_visible () |
Returns whether the sensor should be visible to users in DeviceStudio. | |
bool | is_enabled () |
Get whether or not the sensor is enabled. | |
uint8_t | get_data_report_mode () |
Get data report mode of the sensor. | |
void | SensorComm_Set_Ble_Status (bool status) |
Detailed Description
SSMAX8614XComm Command handler class for communication with MAX30101 on SmartSensor board.
Definition at line 54 of file SSMAX8614XComm.h.
Constructor & Destructor Documentation
SSMAX8614XComm | ( | USBSerial * | USB, |
SSInterface * | ssInterface, | ||
DSInterface * | dsInterface | ||
) |
SSMAX8614XComm constructor.
Definition at line 91 of file SSMAX8614XComm.cpp.
Member Function Documentation
void comm_init | ( | MaximSensor * | s ) | [inherited] |
Initializer for SensorComm.
- Parameters:
-
[in] s MaximSensor instance to handle sensor commands.
Definition at line 53 of file SensorComm.cpp.
int data_report_execute | ( | char * | buf, |
int | size | ||
) | [virtual] |
Fill in buffer with sensor data.
- Parameters:
-
[in] buf Buffer to fill data into [in] size Maximum size of buffer [out] Number of bytes written to buffer
Reimplemented from SensorComm.
Definition at line 1130 of file SSMAX8614XComm.cpp.
const char * get_algo_ver | ( | ) | [virtual, inherited] |
Get the maxim algorithm version of the sensor.
- Parameters:
-
[out] char* to name (ie "max86140")
Definition at line 83 of file SensorComm.cpp.
uint8_t get_data_report_mode | ( | ) | [inherited] |
Get data report mode of the sensor.
- Parameters:
-
[out] data report mode
Definition at line 111 of file SensorComm.cpp.
int get_part_info | ( | uint8_t * | part_id, |
uint8_t * | part_rev | ||
) | [inherited] |
Get the id and revision of the part.
Definition at line 95 of file SensorComm.cpp.
const char* get_part_name | ( | ) | [virtual] |
Get the maxim part number of the device.
Reimplemented from SensorComm.
Definition at line 89 of file SSMAX8614XComm.h.
const char * get_type | ( | ) | [inherited] |
Get the type of the sensor.
- Parameters:
-
[out] char* to name of type (ie "ppg")
Definition at line 58 of file SensorComm.cpp.
bool is_enabled | ( | ) | [inherited] |
Get whether or not the sensor is enabled.
- Parameters:
-
[out] true if the sensor is enabled
Definition at line 106 of file SensorComm.cpp.
bool is_visible | ( | ) | [inherited] |
Returns whether the sensor should be visible to users in DeviceStudio.
Definition at line 114 of file SensorComm.h.
bool parse_command | ( | const char * | cmd ) | [virtual] |
Parses DeviceStudio-style commands.
Parses and executes commands. Prints return code to i/o device.
- Returns:
- true if sensor acted upon the command, false if command was unknown
Reimplemented from SensorComm.
Definition at line 264 of file SSMAX8614XComm.cpp.
bool self_test_result_evaluate | ( | const char * | message, |
uint8_t | value | ||
) |
Evaluate the accelerometer self test routine.
- Parameters:
-
message - message to be printed in the failure cases value - result of the self test passed as parameter
- Returns:
- true if result is SUCCESSFULL false otherwise
Definition at line 1413 of file SSMAX8614XComm.cpp.
int selftest_accelerometer | ( | ) |
Execute the accelerometer self test routine.
- Returns:
- SS_SUCCESS or error code
Definition at line 1390 of file SSMAX8614XComm.cpp.
int selftest_max8614x | ( | ) |
Execute the smart sensor self test routine.
- Returns:
- SS_SUCCESS or error code
Definition at line 1364 of file SSMAX8614XComm.cpp.
void SensorComm_Set_Ble_Status | ( | bool | status ) | [inherited] |
- Parameters:
-
status
Definition at line 195 of file SensorComm.cpp.
void stop | ( | ) | [virtual] |
Stop collecting data and disable sensor.
Reimplemented from SensorComm.
Definition at line 124 of file SSMAX8614XComm.cpp.
Generated on Tue Jul 12 2022 20:09:29 by
