Maxim Integrated / 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

SensorComm Class Reference
Public Member Functions

SensorComm Class Reference

SensorComm is Maxim Sensor Studio GUI command handler base class. More...

#include <SensorComm.h>

Inherited by EcgComm, SSBootloaderComm, SSGenericCmd, SSMAX8614XComm, and TempComm.

Public Member Functions

 SensorComm (const char *type, bool visible)
 SensorComm constructor.
virtual ~SensorComm ()
 SensorComm destructor.
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 bool parse_command (const char *cmd)
 Parses DeviceStudio commands.
virtual int data_report_execute (char *buf, int size)
 Fill in buffer with sensor data.
void SensorComm_Set_Ble_Status (bool status)

Detailed Description

SensorComm is Maxim Sensor Studio GUI command handler base class.

SensorComm includes base functions and data structures for to create new command handler classes. All command handler classes should implement this class.

Definition at line 47 of file SensorComm.h.

Constructor & Destructor Documentation

SensorComm ( const char *  type,
bool  visible 
)

SensorComm constructor.

Parameters:
[in]sensorTypeName of sensor (ie "ppg")
[in]visibleWhether this sensor should be visible to users in DeviceStudio

Definition at line 42 of file SensorComm.cpp.

~SensorComm (  ) [virtual]

SensorComm destructor.

Definition at line 49 of file SensorComm.cpp.

Member Function Documentation

void comm_init ( MaximSensor *  s )

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]

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]

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 (  )

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 
)

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 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 (  )

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 (  )

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 (  )

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 commands.

Parses and executes commands. Prints return code to i/o device.

Parameters:
[in]cmd- Command to parse
Returns:
true if sensor acted upon the command, false if command was unknown

Reimplemented in EcgComm, SSBootloaderComm, SSGenericCmd, SSMAX8614XComm, and TempComm.

Definition at line 191 of file SensorComm.cpp.

void SensorComm_Set_Ble_Status ( bool  status )
Parameters:
status

Definition at line 195 of file SensorComm.cpp.

void stop (  ) [virtual]

Stop collecting data and disable sensor.

Reimplemented in EcgComm, SSMAX8614XComm, and TempComm.

Definition at line 189 of file SensorComm.cpp.

Generated on Wed Jul 13 2022 22:33:03 by  doxygen 1.7.2