Arun Raj / Mbed OS MAXREFDES101_SOURCE

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

Embed: (wiki syntax)

« Back to documentation index

SSGenericCmd Class Reference
Public Member Functions

SSGenericCmd Class Reference

SSMAX30101Comm Command handler class for communication with MAX30101 on SmartSensor board. More...

#include <SSGenericCmd.h>

Inherits SensorComm.

Public Member Functions

 SSGenericCmd (USBSerial *USB, SSInterface *ssInterface, DSInterface *dsInterface)
 SSMAX30101Comm constructor.
bool parse_command (const char *cmd)
 Parses DeviceStudio-style commands.
void comm_init (MaximSensor *s)
 Initializer for SensorComm.
const char * get_type ()
 Get the type of the sensor.
virtual const char * get_part_name ()
 Get the maxim part name 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.
virtual void stop ()
 Stop collecting data and disable sensor.
virtual int data_report_execute (char *buf, int size)
 Fill in buffer with sensor data.
void SensorComm_Set_Ble_Status (bool status)

Detailed Description

SSMAX30101Comm Command handler class for communication with MAX30101 on SmartSensor board.

Definition at line 66 of file SSGenericCmd.h.

Constructor & Destructor Documentation

SSGenericCmd ( USBSerial *  USB,
SSInterface *  ssInterface,
DSInterface *  dsInterface 
)

SSMAX30101Comm constructor.

Definition at line 47 of file SSGenericCmd.cpp.

Member Function Documentation

void comm_init ( MaximSensor *  s ) [inherited]

Initializer for SensorComm.

Parameters:
[in]sMaximSensor instance to handle sensor commands.

Definition at line 53 of file SensorComm.cpp.

int data_report_execute ( char *  buf,
int  size 
) [virtual, inherited]

Fill in buffer with sensor data.

Parameters:
[in]bufBuffer to fill data into
[in]sizeMaximum size of buffer
[out]Numberof bytes written to buffer

Reimplemented in EcgComm, SSMAX8614XComm, and TempComm.

Definition at line 193 of file SensorComm.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]datareport 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, inherited]

Get the maxim part name of the sensor.

Parameters:
[out]char*to name (ie "max86140")

Reimplemented in SSMAX8614XComm.

Definition at line 71 of file SensorComm.cpp.

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]trueif 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 52 of file SSGenericCmd.cpp.

void SensorComm_Set_Ble_Status ( bool  status ) [inherited]
Parameters:
status

Definition at line 195 of file SensorComm.cpp.

void stop (  ) [virtual, inherited]

Stop collecting data and disable sensor.

Reimplemented in EcgComm, SSMAX8614XComm, and TempComm.

Definition at line 189 of file SensorComm.cpp.

Generated on Tue Jul 12 2022 20:09:29 by  doxygen 1.7.2