Skip to content

Latest commit

 

History

History
705 lines (644 loc) · 35.4 KB

README.md

File metadata and controls

705 lines (644 loc) · 35.4 KB
Raw

DFRobot_RP2040_SCI

===========================

This SCI acquisition module is a sensor adapter designed by DFRobot. It supports all kinds of digital, analog, I2C, and UART sensors from DFRobot. The module is capable of standardizing sensor output into the format of name+data+unit, which then will be read by main controllers or displayed on the onboard display so users can view it. The following demonstrates more details about this product through Q&A:

  • Q1: DFRobot has so many sensors, so can this board recognize all of them?
    A: Sorry, it can't. This board only supports part of DFRobot's sensors currently. You can check the supported product list on the library Readme, SKU select on display, or read sensor type through a controller.
  • Q2: What if the analog, digital, I2C or UART sensor I want to use is not in the supported SKU list?
    A: Don't worry about it. The SCI Acquisition Module features USB firmware upgrading function. Please leave us comments and we'll add the sensor to the list. Then it will be available once you upgrade your firmware to the latest.
  • Q3: How does the SCI Acquisition module recognize different sensors?
    A: Each sensor from DFRobot has a unique SKU. The adapter can identify the connected sensor through automatic identification or the user-selected SKU, and call the corresponding driver to acquire and convert data. (Note: For some I2C sensors, the adapter can identify the SKU by I2C address, but for the others, it can only identify the connected one by user-selected SKU.)
  • Q4: How is the SCI Acquisition Module connected to these sensors?
    A: The adapter has an onboard Gravity 3pin analog/digital interfaces (for connecting analog or digital sensors) and 2 Gravity 4pin I2C/UART interfaces (for connecting I2C or UART sensors), so users can connect the corresponding sensor by switching to the corresponding interface mode.
  • Q5: What are the onboard display and button used for?
    A: Users can configure or view the module parameters such as I2C slave address, time, interface mode, SKU select, firmware version, and sensor data by the onboard display and buttons.
  • Q6: How can I use Arduino or Raspberry Pi to read and set parameters of SCI Acquisition Module, and read the sensor data?
    A: Connect your controller to the acquisition module via the onboard Gravity I2C interface, and then you can operate the module. Find more details on the wiki page.
  • Q7: What's the USB on the module used for?
    A: It's used for firmware upgrading or CSV file export. Press the boot button and power on the module to enter the firmware upgrading mode, then you can upgrade the firmware. When it's powered on directly, a U-disk will pop up on your PC and you can view or export the CSV file of recorded sensor data in the U-disk.

Product Image

Product Link (https://www.dfrobot.com/product-2655.html)

SKU: DFR0999

Supported Analog SKU

  • SEN0114
  • SEN0161
  • SEN0193
  • SEN0231
  • SEN0232
  • SEN0244
  • DFR0300

Supported Digital SKU

  • KIT0021

Supported I2C SKU

  • TEL0157
  • KIT0176
  • DFR0216
  • SEN0206
  • SEN0228
  • SEN0291
  • SEN0304
  • SEN0321
  • SEN0322
  • SEN0334
  • SEN0364
  • SEN0456
  • SEN0460
  • SEN0497
  • SEN0514
  • SEN0517
  • SEN0518
  • SEN0529
  • SEN0536
  • SEN0540

Supported UART SKU

  • NULL

Table of Contents

Summary

This is an Arduino library for the DFRobot SCI Acquisition module. It aims to provide users with a series of interface functions to set and read module parameters or read sensor data. Its functions are as follows:

    1. Read/set the I2C address of SCI Acquisition Module within the range of 0x01~0x7F;
    1. Read/set the time information of year, month, day, hour, minute and second of SCI Acquisition Module;
    1. Enable/disable sensor data record of CSV file;
    1. Enable/disable the display;
    1. Read/set the interface mode and SKU of the sensor;
    1. Read sensor data (name + value + unit);
    1. Read the supported product SKU list, including, analog, digital, I2C, UART and other types of sensors;

Installation

There two methods:

  1. To use this library, first download the library file, paste it into the \Arduino\libraries directory, then open the examples folder and run the demo in the folder.
  2. Search the DFRobot_RP2040_SCI library from the Arduino Software Library Manager and download it.

Methods

  /**
   * @fn DFRobot_RP2040_SCI_IIC
   * @brief Constructor for DFRobot_RP2040_SCI_IIC class
   * @param addr:  7-bit I2C address, support the following address settings
   * @n RP2040_SCI_ADDR_0X21      0x21 default I2C address
   * @n RP2040_SCI_ADDR_0X22      0x22
   * @n RP2040_SCI_ADDR_0X23      0x23
   * @n Or view the I2C address on the initial page of the onboard OLED display, the factory default I2C address is 0x01
   * @param pWire:   TwoWire class & object pointer
   */
  DFRobot_RP2040_SCI_IIC(uint8_t addr = RP2040_SCI_ADDR_0X21, TwoWire *pWire = &Wire);
  ~DFRobot_RP2040_SCI_IIC();

  /**
   * @fn setI2CAddress
   * @brief Set I2C address of SCI Acquisition Module
   * 
   * @param addr    I2C address of SCI Acquisition Module, support the following address settings
   * @n RP2040_SCI_ADDR_0X21      0x21 default I2C address
   * @n RP2040_SCI_ADDR_0X22      0x22
   * @n RP2040_SCI_ADDR_0X23      0x23
   * @return uint8_t Error Code
   * @n      ERR_CODE_NONE         or 0x00  Set successful
   * @n      ERR_CODE_CMD_INVAILED or 0x01  Invalid command
   * @n      ERR_CODE_RES_PKT      or 0x02  Response packet error
   * @n      ERR_CODE_M_NO_SPACE   or 0x03  Insufficient memory of I2C controller(master)  
   * @n      ERR_CODE_RES_TIMEOUT  or 0x04  Response packet receive timeout
   * @n      ERR_CODE_CMD_PKT      or 0x05  Invalid command packet or unmatched command  
   * @n      ERR_CODE_I2C_ADRESS   or 0x0A  Invalid I2C address
   */
  uint8_t setI2CAddress(uint8_t addr);

  /**
   * @fn getI2CAddress
   * @brief Get the I2C address of SCI Acquisition Module
   * @return I2C address
   */
  uint8_t getI2CAddress();

  /**
   * @fn DFRobot_RP2040_SCI
   * @brief Constructor of DFRobot_RP2040_SCI class.
   */
  DFRobot_RP2040_SCI();

  /**
   * @fn  ~DFRobot_RP2040_SCI
   * @brief Destructor of class DFRobot_RP2040_SCI. 
   */
  ~DFRobot_RP2040_SCI();
  
  /**
   * @fn begin
   * @brief Initalize the SCI Acquisition Module, mainly for initializing communication interface
   * 
   * @param freq Set communication frequency, no more than 100kHz
   * @return int Init status
   * @n       0  Init successful
   * @n      -1  The communication interface class & object are not passed in
   * @n      -2  Check if the hardware connection is correct
   */
  int begin(uint32_t freq = 100000);

  /**
   * @fn getVersion
   * @brief Get firmware version number of SCI Acquisition Module
   * @n The version number is 16-bit data, the high 8bits(b15-b9) represent the leftmost number
   * @n The middle 4bits (b8-b4) represent the middle number
   * @n The low 4bits represent the rightmost number 
   * @n For example, 0x0123 corresponds to V1.2.3
   * 
   * @return 16-bit version number
   */
  uint16_t getVersion();

  /**
   * @fn getVersionDescription
   * @brief Get version description char string
   * 
   * @return Return version description char string, e.g. id：0x0123 The returned version decription char string is V1.2.3
   */
  String getVersionDescription(uint16_t version);

  /**
   * @fn setPort1(char *sku)
   * @brief Set SKU on Port1, which can be connected to analog & digital sensors, select the sensor connected to Port1 by SKU
   * 
   * @param sku  Parameters for Port1, The supported SKU list can be viewed on OLED display or by getAnalogSensorSKU()/getDigitalSensorSKU()
   * @n     "NULL"       Clear sensor settings for Port1 and configure mode as analog sensor mode
   * @n     "Analog"     Select analog voltage data acquisition, unit mV 
   * @n     Analog sensor SKU  Select the SKU of an analog sensor and configure mode as analog sensor mode
   * @n     Digital sensor SKU Select the SKU of a digital sensor and configure mode as digital sensor mode
   * @return uint8_t Error Code
   * @n      ERR_CODE_NONE         or 0x00  Setting succeed
   * @n      ERR_CODE_CMD_INVAILED or 0x01  Invalid command
   * @n      ERR_CODE_RES_PKT      or 0x02  Response package error
   * @n      ERR_CODE_M_NO_SPACE   or 0x03  Insufficient memory of I2C controller(master)
   * @n      ERR_CODE_RES_TIMEOUT  or 0x04  Response package receive timeout
   * @n      ERR_CODE_CMD_PKT      or 0x05  Invalid command package or unmatched command 
   * @n      ERR_CODE_SLAVE_BREAK  or 0x06  Peripheral(slave) fault
   * @n      ERR_CODE_ARGS         or 0x07  Set wrong parameters 
   */
  uint8_t setPort1(char *sku);

  /**
   * @fn getPort1(ePort1IFMode_t mode)
   * @brief Get the sensor mode on port1 and SKU config
   * 
   * @param mode  eADIFMode_t enum variable pointer
   * @n     eAnalogMode    Analog sensor mode
   * @n     eDigitalMode   Digital sensor mode
   * @return SKU of the sensor connected to port1
   * @n      "NULL"        Port1 is configured or connected to no sensor 
   * @n      "Analog"      Port1 is configured as reading its voltage data
   * @n      7-bit SKU     Port1 is configured as reading data from a digital or analog sensor
   */
  String getPort1(ePort1IFMode_t *mode);

  /**
   * @fn setPort2(char *sku)
   * @brief Set SKU on Port2, which can be connected to I2C & UART sensors. I2C sensors can be auto selected when connected, 
     @ you just need to configure the mode as I2C mode for port2. But for UART sensors, please select by SKU. 
   * 
   * @param sku  Parameters for Port2, the supported SKU list can be viewed on the OLED display or by getUARTSensorSKU()
   * @n     "NULL"       Configure Port2 as I2C mode and clear the config related to UART sensor on Port2
   * @n     UART sensor SKU indicates a UART sensor SKU is selected and the mode is configured as UART sensor mode
   * @return uint8_t Error code
   * @n      ERR_CODE_NONE         or 0x00  Setting succeed
   * @n      ERR_CODE_CMD_INVAILED or 0x01  Invalid command
   * @n      ERR_CODE_RES_PKT      or 0x02  Response package error
   * @n      ERR_CODE_M_NO_SPACE   or 0x03  Insufficient memory of I2C controller
   * @n      ERR_CODE_RES_TIMEOUT  or 0x04  Response package receive timeout
   * @n      ERR_CODE_CMD_PKT      or 0x05  Invalid command package or unmatched command
   * @n      ERR_CODE_SLAVE_BREAK  or 0x06  Peripheral fault
   * @n      ERR_CODE_ARGS         or 0x07  Set wrong parameters 
   */
  uint8_t setPort2(char *sku);

  /**
   * @fn getPort2(ePort23Mode_t mode)
   * @brief Get the sensor mode on port2 and SKU config
   * 
   * @param mode  eI2CUARTMode_t enum variable pointer
   * @n     eI2CMode    I2C sensor mode
   * @n     eUARTMode   UART sensor mode
   * @return SKU of the sensor connected to Port2
   * @n      "NULL"        Port2 is configured or connected to no sensor
   * @n      7-bit SKU set     The SKU corresponding to I2C or UART sensor
   */
  String getPort2(ePort23Mode_t *mode);

  /**
   * @fn setPort3(char *sku)
   * @brief Set SKU on Port3, which can be connected to I2C & UART sensors. I2C sensors can be auto selected when connected,
     @ you just need to configure the mode as I2C mode for port2. But for UART sensors, please select by SKU.
   * 
   * @param sku  Parameters for Port3, the supported SKU list can be viewed on the OLED display or by getUARTSensorSKU()
   * @n     "NULL"       Configure Port3 as I2C mode and clear the config related to UART sensors on Port3
   * @n     UART sensor SKU indicates a UART sensor SKU is selected and the mode is configured as UART sensor mode
   * @return uint8_t Error code
   * @n      ERR_CODE_NONE         or 0x00  Setting succeed
   * @n      ERR_CODE_CMD_INVAILED or 0x01  Invalid command
   * @n      ERR_CODE_RES_PKT      or 0x02  Response package error
   * @n      ERR_CODE_M_NO_SPACE   or 0x03  Insufficient memory of I2C controller
   * @n      ERR_CODE_RES_TIMEOUT  or 0x04  Response package receive timeout
   * @n      ERR_CODE_CMD_PKT      or 0x05  Invalid command package or unmatched command 
   * @n      ERR_CODE_SLAVE_BREAK  or 0x06  Peripheral fault
   * @n      ERR_CODE_ARGS         or 0x07  Set wrong parameters 
   */
  uint8_t setPort3(char *sku);

  /**
   * @fn getPort3(ePort23Mode_t mode)
   * @brief Get the sensor mode on port3 and SKU config
   * 
   * @param mode  eI2CUARTMode_t enum variable pointer
   * @n     eI2CMode    I2C sensor mode
   * @n     eUARTMode   UART sensor mode
   * @return SKU of the sensor connected to Port3
   * @n      "NULL"        Port3 is configured or connected to no sensor 
   * @n      7-bit SKU set     The SKU corresponding to I2C or UART sensor
   */
  String getPort3(ePort23Mode_t *mode);

  /**
   * @fn setRecvTimeout
   * @brief Set receive timeout
   * 
   * @param timeout When there are many sensors connected to SCI Acquisition Module, you need to increase the receive timeout value appropriately when reading a large amount of data, the default is 2s
   */
  void setRecvTimeout(uint32_t timeout = 2000);

  /**
   * @fn adjustRtc(const __FlashStringHelper* date, const __FlashStringHelper* time)
   * @brief Set time of SCI Acquisition Module
   * 
   * @param date Year, month & day
   * @param time Hour, minute & second
   * @return Error code
   * @n      ERR_CODE_NONE         or 0x00  Setting succeed 
   * @n      ERR_CODE_CMD_INVAILED or 0x01  Invalid command
   * @n      ERR_CODE_RES_PKT      or 0x02  Response package error 
   * @n      ERR_CODE_M_NO_SPACE   or 0x03  Insufficient memory of I2C controller
   * @n      ERR_CODE_RES_TIMEOUT  or 0x04  Response package receive timeout 
   * @n      ERR_CODE_CMD_PKT      or 0x05  Invalid command package or unmatched command 
   */
  uint8_t adjustRtc(const __FlashStringHelper* date, const __FlashStringHelper* time);
	/**
   * @fn adjustRtc(uint16_t year, uint8_t month, uint8_t day, uint8_t week, uint8_t hour, uint8_t minute, uint8_t second)
   * @brief Set time of SCI Acquisition Module
   * 
   * @param year   Year
   * @param month  Month
   * @param day    Day
   * @param week   Week
   * @param hour   Hour
   * @param minute Minute
   * @param second Second
   * @return uint8_t Error code
   * @n      ERR_CODE_NONE         or 0x00  Setting succeed 
   * @n      ERR_CODE_CMD_INVAILED or 0x01  Invalid command 
   * @n      ERR_CODE_RES_PKT      or 0x02  Response package error 
   * @n      ERR_CODE_M_NO_SPACE   or 0x03  Insufficient memory of I2C controller
   * @n      ERR_CODE_RES_TIMEOUT  or 0x04  Response package receive timeout 
   * @n      ERR_CODE_CMD_PKT      or 0x05  Invalid command package or unmatched command
   */
  uint8_t adjustRtc(uint16_t year, uint8_t month, uint8_t day, uint8_t week, uint8_t hour, uint8_t minute, uint8_t second);

  /**
   * @fn getRtcTime(uint16_t *year, uint8_t *month, uint8_t *day, uint8_t *week, uint8_t *hour, uint8_t *minute, uint8_t *second)
   * @brief Get year, month, day, week, hour, minute, second of SCI Acquisition Module
   * 
   * @param year   Year
   * @param month  Month
   * @param day    Day
   * @param week   Week
   * @param hour   Hour
   * @param minute Minute
   * @param second Second
   * @return uint8_t Error code
   * @n      ERR_CODE_NONE         or 0x00  Setting succeed 
   * @n      ERR_CODE_CMD_INVAILED or 0x01  Invalid command 
   * @n      ERR_CODE_RES_PKT      or 0x02  Response package error 
   * @n      ERR_CODE_M_NO_SPACE   or 0x03  Insufficient memory of I2C controller
   * @n      ERR_CODE_RES_TIMEOUT  or 0x04  Response package receive timeout 
   * @n      ERR_CODE_CMD_PKT      or 0x05  Invalid command package or unmatched command
   */
  uint8_t getRtcTime(uint16_t *year, uint8_t *month, uint8_t *day, uint8_t *week, uint8_t *hour, uint8_t *minute, uint8_t *second);

  /**
   * @fn getRtcTime()
   * @brief Get the year, month, day, week, hour, minute, second of the SCI Acquisition Module
   * 
   * @return The char string for year/month/day week hour:minute:second, for example, 2022/08/09 2 09:08:00 represents Tuesday, August 9, 2022, at 9:08:0 
   */
  String getRtcTime();

  /**
   * @fn setRefreshRate
   * @brief Set data refresh rate
   * 
   * @param refreshRate eRefreshRate_t enum variable
   * @n eRefreshRateMs     ms-level, refresh at the actual refresh rate
   * @n eRefreshRate1s     1s, if the actual data refresh rate is less than this value, refresh at this rate, if greater than it, refresh at actual rate
   * @n eRefreshRate3s     3s, if the actual data refresh rate is less than this value, refresh at this rate, if greater than it, refresh at actual rate
   * @n eRefreshRate5s     5s, if the actual data refresh rate is less than this value, refresh at this rate, if greater than it, refresh at actual rate
   * @n eRefreshRate10s    10s, if the actual data refresh rate is less than this value, refresh at this rate, if greater than it, refresh at actual rate
   * @n eRefreshRate30s    30s, if the actual data refresh rate is less than this value, refresh at this rate, if greater than it, refresh at actual rate
   * @n eRefreshRate1min   1min, if the actual data refresh rate is less than this value, refresh at this rate, if greater than it, refresh at actual rate
   * @n eRefreshRate5min   5min, if the actual data refresh rate is less than this value, refresh at this rate, if greater than it, refresh at actual rate
   * @n eRefreshRate10min  10min, if the actual data refresh rate is less than this value, refresh at this rate, if greater than it, refresh at actual rate
   * @return uint8_t Error code
   * @n      ERR_CODE_NONE         or 0x00  Setting succeed
   * @n      ERR_CODE_CMD_INVAILED or 0x01  Invalid command
   * @n      ERR_CODE_RES_PKT      or 0x02  Response package error
   * @n      ERR_CODE_M_NO_SPACE   or 0x03  Insufficient memory of I2C controller
   * @n      ERR_CODE_RES_TIMEOUT  or 0x04  Response package receive timeout
   * @n      ERR_CODE_CMD_PKT      or 0x05  Invalid command package or unmatched command 
   */
  uint8_t setRefreshRate(eRefreshRate_t refreshRate);

  /**
   * @fn getRefreshRate
   * @brief Get the set refresh rate, which may not be the actual rate, the relationship between them is: the set refresh rate <= the actual refresh rate
   * 
   * @param refreshRate eRefreshRate_t enum variable, get the level
   * @n eRefreshRateMs     ms-level, refresh at the actual refresh rate
   * @n eRefreshRate1s     1s, if the actual data refresh rate is less than this value, refresh at this rate, if greater than it, refresh at actual rate 
   * @n eRefreshRate3s     3s, if the actual data refresh rate is less than this value, refresh at this rate, if greater than it, refresh at actual rate
   * @n eRefreshRate5s     5s, if the actual data refresh rate is less than this value, refresh at this rate, if greater than it, refresh at actual rate
   * @n eRefreshRate10s    10s, if the actual data refresh rate is less than this value, refresh at this rate, if greater than it, refresh at actual rate
   * @n eRefreshRate30s    30s, if the actual data refresh rate is less than this value, refresh at this rate, if greater than it, refresh at actual rate
   * @n eRefreshRate1min   1min, if the actual data refresh rate is less than this value, refresh at this rate, if greater than it, refresh at actual rate
   * @n eRefreshRate5min   5min, if the actual data refresh rate is less than this value, refresh at this rate, if greater than it, refresh at actual rate
   * @n eRefreshRate10min  10min, if the actual data refresh rate is less than this value, refresh at this rate, if greater than it, refresh at actual rate
   * @return uint32_t Return refresh rate, unit ms
   * @n eRefreshRateMs     0ms
   * @n eRefreshRate1s     1000ms
   * @n eRefreshRate3s     3000ms
   * @n eRefreshRate5s     5000ms
   * @n eRefreshRate10s    10000ms
   * @n eRefreshRate30s    30000ms
   * @n eRefreshRate1min   60000ms
   * @n eRefreshRate5min   300000ms
   * @n eRefreshRate10min  600000ms
   */
  uint32_t getRefreshRate(eRefreshRate_t *refreshRate = NULL);

  /**
   * @fn getTimeStamp()
   * @brief Get time stamp, also the data refresh time of SCI Acquisition Module
   * 
   * @return Hour:Minute:Second(00:00:00) or Minute:Second. X%(0-99)second(00:00.00)
   */
  String getTimeStamp();
  
  /**
   * @fn getSensorModeDescribe(ePort1IFMode_t mode)
   * @brief Get sensor mode description
   * 
   * @param mode  ePort1IFMode_t enum variable
   * @n     eAnalogMode    Analog sensor mode
   * @n     eDigitalMode   Digital sensor mode
   * @return Sensor mode description char string
   * @n      "ANALOG"         Analog sensor mode
   * @n      "DIGITAL"        Digital sensor mode
   * @n      "UNKNOWN"        Unknown Mode
   */
  String getSensorModeDescribe(ePort1IFMode_t mode);

  /**
   * @fn getSensorModeDescribe(ePort23Mode_t mode)
   * @brief Get sensor mode description
   * 
   * @param mode  ePort23Mode_t enum variable
   * @n     eI2CMode    I2C sensor mode
   * @n     eUARTMode   UART sensor mode
   * @return Sensor mode description char string
   * @n      "I2C"         I2C sensor mode
   * @n      "UART"        UART sensor mode
   * @n      "UNKNOWN"     Unknown Mode
   */
  String getSensorModeDescribe(ePort23Mode_t mode);
  
  /**
   * @fn enableRecord
   * @brief Enable data recording in CSV file. When enabled, the sensor data will be recorded in the csv file named by date year, month, day, hour, minute, and second.
   * 
   * @return uint8_t Error code
   * @n      ERR_CODE_NONE         or 0x00  Setting succeed
   * @n      ERR_CODE_CMD_INVAILED or 0x01  Invalid command
   * @n      ERR_CODE_RES_PKT      or 0x02  Response package error
   * @n      ERR_CODE_M_NO_SPACE   or 0x03  Insufficient memory of I2C controller
   * @n      ERR_CODE_RES_TIMEOUT  or 0x04  Response package receive timeout
   * @n      ERR_CODE_CMD_PKT      or 0x05  Invalid command package or unmatched command
   */
  uint8_t enableRecord();

  /**
   * @fn disableRecord
   * @brief Disable data recording in CSV file. When disabled, data recording stops
   * 
   * @return uint8_t Error code
   * @n      ERR_CODE_NONE         or 0x00  Setting succeed
   * @n      ERR_CODE_CMD_INVAILED or 0x01  Invalid command
   * @n      ERR_CODE_RES_PKT      or 0x02  Response package error
   * @n      ERR_CODE_M_NO_SPACE   or 0x03  Insufficient memory of I2C controller
   * @n      ERR_CODE_RES_TIMEOUT  or 0x04  Response package receive timeout
   * @n      ERR_CODE_CMD_PKT      or 0x05  Invalid command package or unmatched command
   */
  uint8_t disableRecord();
  
  /**
   * @fn oledScreenOn
   * @brief Switch on SCI Acquisition Module Screen
   * 
   * @return uint8_t Error code
   * @n      ERR_CODE_NONE         or 0x00  Setting succeed
   * @n      ERR_CODE_CMD_INVAILED or 0x01  Invalid command
   * @n      ERR_CODE_RES_PKT      or 0x02  Response package error
   * @n      ERR_CODE_M_NO_SPACE   or 0x03  Insufficient memory of I2C controller
   * @n      ERR_CODE_RES_TIMEOUT  or 0x04  Response package receive timeout
   * @n      ERR_CODE_CMD_PKT      or 0x05  Invalid command package or unmatched command
   */
  uint8_t oledScreenOn();

  /**
   * @fn oledScreenOff
   * @brief Switch off SCI Acquisition Module Screen
   * 
   * @return uint8_t Error code
   * @n      ERR_CODE_NONE         or 0x00  Setting succeed
   * @n      ERR_CODE_CMD_INVAILED or 0x01  Invalid command
   * @n      ERR_CODE_RES_PKT      or 0x02  Response package error
   * @n      ERR_CODE_M_NO_SPACE   or 0x03  Insufficient memory of I2C controller
   * @n      ERR_CODE_RES_TIMEOUT  or 0x04  Response package receive timeout
   * @n      ERR_CODE_CMD_PKT      or 0x05  Invalid command package or unmatched command
   */
  uint8_t oledScreenOff();
  
  /**
   * @fn getInformation
   * @brief Get information of the sensor connected to one or more ports of SCI Acquisition Module, name: value unit.
   * @n Separate multiple pieces of information using ","
   * 
   * @param inf    Port select
   * @n     ePort1                                           Select Port1
   * @n     ePort2                                           Select Port2
   * @n     ePort3                                           Select Port3
   * @n     eALL  or  (ePort1 | ePort2 | ePort3)             Select Port1, Port2 and Port3
   * @param timestamp Whether the acquired information is timestamped or not
   * @n     false  Not timestamped
   * @n     ture   Timestamped 
   * @return Attributes of the sensor connected to the selected port, each one is in the format of name:value unit, separate attributes using "," and separate unit and value using a space
   * @n Not timestamped e.g. SEN0334:  Temp_Air:28.65 C,Humi_Air:30.12 %RH
   * @n Timestamped   e.g. SEN0334:  Minute:Second. X%(0-99)second Temp_Air:28.65 C,Humi_Air:30.12 %RH or Hour:Minute:Second Temp_Air:28.65 C,Humi_Air:30.12 %RH
   */
  String getInformation(eInterfaceList_t inf = eALL, bool timestamp = false);
  String getInformation(uint8_t inf, bool timestamp = false);

  /**
   * @fn getSKU
   * @brief Get the SKU of the sensor connected to one or more ports of SCI Acquisition Module, separate SKUs using ","
   * 
   * @param inf    Port select
   * @n     ePort1                                           Select Port1
   * @n     ePort2                                           Select Port2
   * @n     ePort3                                           Select Port3
   * @n     eALL  or  (ePort1 | ePort2 | ePort3)             Select Port1, Port2 and Port3
   * @return The SKU of the sensor connected to the selected port, separate SKUs using ","
   * @n For example:  SEN0161,SEN0334
   */
  String getSKU(eInterfaceList_t inf = eALL);
  String getSKU(uint8_t inf);

  /**
   * @fn getKeys
   * @brief Get the name of the sensor connected to one or more ports, separate names using ","
   * 
   * @param inf    Port select
   * @n     ePort1                                           Select Port1
   * @n     ePort2                                           Select Port2
   * @n     ePort3                                           Select Port3
   * @n     eALL  or  (ePort1 | ePort2 | ePort3)             Select Port1, Port2 and Port3
   * @return The name of the sensor connected to the selected port, separate names using ","
   * @n For example:  Temp_Air,Humi_Air
   */
  String getKeys(eInterfaceList_t inf = eALL);
  String getKeys(uint8_t inf);

  /**
   * @fn getValues
   * @brief Get attribute values of the sensor connected to one or more ports, separate attribute values using ","
   * 
   * @param inf    Port select
   * @n     ePort1                                           Select Port1
   * @n     ePort2                                           Select Port2
   * @n     ePort3                                           Select Port3
   * @n     eALL  or  (ePort1 | ePort2 | ePort3)             Select Port1, Port2 and Port3
   * @return The attribute values of the sensor connected to the selected port, separate attribute values using ","
   * @n For example:  28.65,30.12
   */
  String getValues(eInterfaceList_t inf = eALL);
  String getValues(uint8_t inf);

  /**
   * @fn getUnits
   * @brief Get the value unit of the sensor connected to one or more ports, separate units using ","
   * 
   * @param inf    Port select
   * @n     ePort1                                           Select Port1
   * @n     ePort2                                           Select Port2
   * @n     ePort3                                           Select Port3
   * @n     eALL  or  (ePort1 | ePort2 | ePort3)             Select Port1, Port2 and Port3
   * @return The value unit of the sensor connected to the selected port, separate units using ","
   * @n For example:  C,%RH
   */
  String getUnits(eInterfaceList_t inf = eALL);
  String getUnits(uint8_t inf);

  /**
   * @fn getValue(char *keys)
   * @brief Get data values of the attribute named keys from sensors connected to all ports. Separate attribute values using "," 
   * @param keys  Sensor attribute name
   * @return Data values of the attribute named keys from sensors connected to all ports. Separate attribute values using ","
   * @n For example, Temp_Air:  28.65,28.65
   */
  String getValue(char *keys);

  /**
   * @fn getValue(eInterfaceList_t inf, char *keys)
   * @brief Get data values of the attribute named keys from sensors connected to the designated port. Separate attribute values using ","
   * @param inf    Port select, and parameter search range
   * @n     ePort1                                          Select Port1, and search data values of the attribute named keys from sensors connected to A&D ports
   * @n     ePort2                                          Select Port2, and search data values of the attribute named keys from sensors connected to I2C & UART1 ports
   * @n     ePort3                                          Select Port3, and search data values of the attribute named keys from sensors connected to I2C & UART2 ports
   * @n     eALL  or  (ePort1 | ePort2 | ePort3)            Select ePort1, ePort2 & ePort3, and search data values of the attribute named keys from sensors connected to all ports
   * @param keys  Sensor attribute name
   * @return The data values of the attribute named keys from sensors connected to the designated port. Separate attribute values using ","
   * @n For example, Temp_Air:  28.65,28.65
   */
  String getValue(eInterfaceList_t inf, char *keys);
  String getValue(uint8_t inf, char *keys);

  /**
   * @fn getValue(eInterfaceList_t inf, char sku[7], char *keys)
   * @brief Get data values of the attribute named keys from the sensor with a specific sku among sensors connected to the designated port. 
   * @ Separate attribute values using ","
   * @param inf    Port select, and parameter search range
   * @n     ePort1                                          Select port1, search the sensor whose SKU is sku from port1, and read data values of the attribute named keys  
   * @n     ePort2                                          Select port2, search the sensor whose SKU is sku from port2, and read data values of the attribute named keys
   * @n     ePort3                                          Select port3, search the sensor whose SKU is sku from port3, and read data values of the attribute named keys
   * @n     eALL  or  (ePort1 | ePort2 | ePort3)            Select ePort1, ePort2 and ePort3, search sensors whose SKU is sku from all ports, and read data values of the attribute named keys
   * @param sku Sensor SKU
   * @param keys  Sensor attribute name
   * @return The data values of the attribute named keys from the sensor with a specific sku among sensors connected to the designated port.
   * @ Separate attribute values using ","
   * @n For example, Temp_Air:  28.65,28.65
   */
  String getValue(eInterfaceList_t inf, char sku[7], char *keys);
  String getValue(uint8_t inf, char sku[7], char *keys);

  /**
   * @fn getUnit(eInterfaceList_t inf, char sku[7], char *keys)
   * @brief Get data units of the attribute named keys from sensors connected to all ports. Separate attribute units using ","
   * 
   * @param keys  Sensor attribute name
   * @return  Data units of the attribute named keys from sensors connected to all ports. Separate attribute units using ","
   * @n For example, Temp_Air:  C,C
   */
  String getUnit(char *keys);

  /**
   * @fn getUnit(eInterfaceList_t inf, char sku[7], char *keys)
   * @brief Get data units of the attribute named keys from sensors connected to the designated port. Separate attribute units using ","
   * @param inf    Port select, and parameter search range
   * @n     ePort1                                          Select Port1, and search get data units of the attribute named keys from sensors connected to port1
   * @n     ePort2                                          Select Port2, and search get data units of the attribute named keys from sensors connected to port2
   * @n     ePort3                                          Select Port3, and search get data units of the attribute named keys from sensors connected to port3
   * @n     eALL  or  (ePort1 | ePort2 | ePort3)      Select Port1, Port2 and Port3, and search data units of the attribute named keys from sensors connected to all ports 
   * @param keys  Sensor attribute name
   * @return The data units of the attribute named keys from sensors connected to the designated port. Separate attribute units using ","
   * @n For example, Temp_Air:  C,C
   */
  String getUnit(eInterfaceList_t inf, char *keys);
  String getUnit(uint8_t inf, char *keys);

  /**
   * @fn getUnit(eInterfaceList_t inf, char sku[7], char *keys)
   * @brief Get data units of the attribute named keys from the sensor with a specific sku among sensors connected to the designated port.
   * @ Separate attribute units using ","
   * @param inf    Port select, and parameter search range
   * @n     ePort1                                          Select Port1, search the sensor whose SKU is sku from port1, and read data units of the attribute named keys
   * @n     ePort2                                          Select Port2, search the sensor whose SKU is sku from port2, and read data units of the attribute named keys
   * @n     ePort3                                          Select Port3, search the sensor whose SKU is sku from port3, and read data units of the attribute named keys
   * @n     eALL  or  (ePort1 | ePort2 | ePort3)      Select Port1, Port2 and Port3, search sensors whose SKU is sku from all ports, and read data units of the attribute named keys
   * @param sku Sensor SKU
   * @param keys  Sensor attribute name
   * @return The data units of the attribute named keys from the sensor with a specific sku among sensors connected to the designated port. 
   * @ Separate attribute units using ","
   * @n For example, Temp_Air:  C,C
   */
  String getUnit(eInterfaceList_t inf, char sku[7], char *keys);
  String getUnit(uint8_t inf, char sku[7], char *keys);

  /**
   * @fn getAnalogSensorSKU
   * @brief Get the SKU list of analog sensors supported by SCI Acquisition Module, separate SKUs with ','   * 
   * @return String SKU list of supported analog sensors
   */
  String getAnalogSensorSKU();

  /**
   * @fn getDigitalSensorSKU
   * @brief Get the SKU list of digital sensors supported by SCI Acquisition Module, separate SKUs with ','   * 
   * @return String SKU list of supported digital sensors
   */
  String getDigitalSensorSKU();

  /**
   * @fn getI2CSensorSKU
   * @brief Get the SKU list of I2C sensors supported by SCI Acquisition Module, separate SKUs with ','   * 
   * @return String SKU list of supported I2C sensors
   */
  String getI2CSensorSKU();

  /**
   * @fn getUARTSensorSKU
   * @brief Get the SKU list of UART sensors supported by SCI Acquisition Module, separate SKUs with ','   * 
   * @return String SKU list of supported UART sensors
   */
  String getUARTSensorSKU();

Compatibility

MCU Work Well Work Wrong Untested Remarks
Arduino Uno √
Mega2560 √
Leonardo √
ESP32 √
ESP8266 √
micro:bit √
FireBeetle M0 √

History

  • 2021/08/17 - Version 1.0.0 released.
  • 2023/02/03 - Version 1.0.1 released.
  • 2023/03/23 - Version 1.0.2 released.

Credits

Written by Arya(xue.peng@dfrobot.com), 2022. (Welcome to our website)