#include “cdevice.h”
An enumeration used to describe possible device parameters.
Description
ParameterName |
Device name |
ParameterState |
Device status |
ParameterAddress |
Device address |
ParameterSerialNumber |
Serial number of the device |
ParameterFirmwareMode |
Device operation mode |
ParameterSamplingFrequency |
Physiological signal sampling rate |
ParameterGain |
Signal gain |
ParameterOffset |
Signal offset |
ParameterFirmwareVersion |
Device firmware version |
parameter_to_string |
Function. Converting to string. Converts an enumeration element to text. Options: param Description: Enumeration element Data type: Parameter buffer Description: the string value of the enumeration element Data type: char* buffer_length Description: buffer length Data type: size_t Return value: Description: An indication of an error. More details sdk_error Data type: int. |
Options not listed in the table are not supported.
Operations with parameters
#include “cparams.h”
device_read_Name |
Function. Device name query. Returns the device name. Options: device_ptr Description: Device class instance Data type: Device* out_name Description: device name Data type: char* length Description: name length Data type: size_t Return value: Description: An indication of an error. More details sdk_error Data type: int. |
device_read_State |
Function. Device status query. Returns the connection status of a device. Options: device_ptr Description: Device class instance Data type: Device* out_state Description: device status Data type: DeviceState* Return value: Description: An indication of an error. More details sdk_error Data type: int. |
device_read_Address |
Function. Device address request. Returns the address of the device. Options: device_ptr Description: Device class instance Data type: Device* out_address Description: device address Data type: char* length Description: address length Data type: size_t Return value: Description: An indication of an error. More details sdk_error Data type: int. |
device_read_SerialNumber |
Function. Requesting the serial number of the device. Returns the serial number of the device. Options: device_ptr Description: Device class instance Data type: Device* out_serial Description: serial number of the device Data type: char* length Description: serial number length Data type: size_t Return value: Description: An indication of an error. More details sdk_error Data type: int. |
device_read_FirmwareMode |
Function. Device operating mode request. Returns the device operating mode. Options: device_ptr Description: Device class instance Data type: Device* out_mode Description: device operating mode Data type: FirmwareMode* Return value: Description: An indication of an error. More details sdk_error Data type: int. |
device_read_SamplingFrequency |
Function. Signal sampling rate request. Returns the sampling rate of a physiological signal. Options: device_ptr Description: Device class instance Data type: Device* out_freq Description: physiological signal sampling rate Data type: SamplingFrequency* Return value: Description: An indication of an error. More details sdk_error Data type: int. |
device_read_Gain |
Function. Signal gain request. Returns the value of the signal gain. Options: device_ptr Description: Device class instance Data type: Device* out_gain Description: signal gain Data type: Gain* Return value: Description: An indication of an error. More details sdk_error Data type: int. |
device_read_Offset |
Function. Signal Offset Request. Returns the offset value of the signal. Options: device_ptr Description: Device class instance Data type: Device* out_offset Description: signal offset Data type: unsigned char* Return value: Description: An indication of an error. More details sdk_error Data type: int. |
device_read_FirmwareVersion |
Function. Requesting the firmware version of the device. Returns the device firmware version. Options: device_ptr Description: Device class instance Data type: Device* out_firmware_version Description: device firmware version Data type: FirmwareVersion* Return value: Description: An indication of an error. More details sdk_error Data type: int. |
device_set_FirmwareMode |
Function. Setting the device operating mode. Sets the device operating mode to the transmitted value. Options: device_ptr Description: Device class instance Data type: Device* mode Description: device operating mode Data type: FirmwareMode* Return value: Description: An indication of an error. More details sdk_error Data type: int. |
device_set_SamplingFrequency |
Function. Setting the sampling frequency of the signal. Sets the sampling rate of the physiological signal to the transmitted value. Options: device_ptr Description: Device class instance Data type: Device* freq Description: physiological signal sampling rate Data type: SamplingFrequency* Return value: Description: An indication of an error. More details sdk_error Data type: int. |
device_set_Gain |
Function. Setting the signal gain. Sets the signal gain value to the transmitted value. Options: device_ptr Description: Device class instance Data type: Device* gain Description: signal gain Data type: Gain* Return value: Description: An indication of an error. More details sdk_error Data type: int. |
device_set_Offset |
Function. Setting the signal offset. Sets the signal offset value to the transmitted value. Options: device_ptr Description: Device class instance Data type: Device* offset Description: signal offset Data type: unsigned char* Return value: Description: An indication of an error. More details sdk_error Data type: int. |