Maxim Integrated / Mbed OS MAXREFDES220_HEART_RATE_MONITOR

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:   USBDevice max32630fthr

Fork of MAXREFDES220# by Maxim Integrated

Embed: (wiki syntax)

« Back to documentation index

DSInterface Class Reference
Public Member Functions | Protected Member Functions

DSInterface Class Reference

DSInterface is Maxim's DeviceStudio Interface class. More...

#include <DSInterface.h>

Public Member Functions

 DSInterface (USBSerial *USB)
 DSInterface constructor.
virtual ~DSInterface ()
 DSInterface destructor.
void add_sensor_comm (SensorComm *s)
 Add SensorComm for DSInterface to pass commands to.
void build_command (char ch)
 Command builder from i/o device.
void data_report_execute ()
 Prints latest sensor data to USB stream.
void set_fw_version (const char *fw_version)
 Set the fw version which DSInterface will replay with for "get_device_info" command.
void set_fw_platform (const char *fw_platform)
 Set the fw platform which DSInterface will replay with for "get_device_info" command.
void enable_console_interface ()
 Enable data output on the console interface (USB)

Protected Member Functions

void parse_command ()
 Parses DeviceStudio commands.

Detailed Description

DSInterface is Maxim's DeviceStudio Interface class.

Definition at line 59 of file DSInterface.h.

Constructor & Destructor Documentation

DSInterface ( USBSerial *  USB )

DSInterface constructor.

Parameters:
[in]fw_versionFirmware version number.
[in]fw_platformFirmware platform name.
[in]USBPointer to USBSerial device

Definition at line 65 of file DSInterface.cpp.

~DSInterface (  ) [virtual]

DSInterface destructor.

Definition at line 80 of file DSInterface.cpp.

Member Function Documentation

void add_sensor_comm ( SensorComm *  s )

Add SensorComm for DSInterface to pass commands to.

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

Definition at line 84 of file DSInterface.cpp.

void build_command ( char  ch )

Command builder from i/o device.

Reads character and builds command from DeviceStudio commands.

Parameters:
[in]chInput character from i/o device.

Definition at line 95 of file DSInterface.cpp.

void data_report_execute (  )

Prints latest sensor data to USB stream.

Should be called on every pass thorugh the main loop in main.cpp

Definition at line 249 of file DSInterface.cpp.

void enable_console_interface (  )

Enable data output on the console interface (USB)

Definition at line 90 of file DSInterface.cpp.

void parse_command (  ) [protected]

Parses DeviceStudio commands.

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

Definition at line 127 of file DSInterface.cpp.

void set_fw_platform ( const char *  fw_platform )

Set the fw platform which DSInterface will replay with for "get_device_info" command.

Parameters:
[in]fw_platformFirmware platform name.

Definition at line 281 of file DSInterface.cpp.

void set_fw_version ( const char *  fw_version )

Set the fw version which DSInterface will replay with for "get_device_info" command.

Parameters:
[in]fw_versionFirmware version number.

Definition at line 275 of file DSInterface.cpp.

Generated on Mon Jul 18 2022 23:37:28 by  doxygen 1.7.2