Reference

Library

Download and install the DFRobot_mmWave Radar Library. (About how to install the library?)

Communication Protocol Description

The module adopts serial communication protocol and uses ASCII code string as command interation and data interaction.

• Serial communication configuration: 115200 baud rate, 1 stop bit, 8 data bits, no parity bit, no flow control
• Command interaction: ASCII code string format, ending with a new line; separated by space between commands to parameters, parameters to parameters.
• When configuring the working parameters of the sensor, the sensor must be in a halted state; after the parameter configuration is completed, a save parameter command must be sent to save the changed parameters in the non-power-loss memory.
• If using this module as a trigger switch, that is, only use the I/O port of the module, and at the same time, when the configuration parameters meet the performance and functional requirements, the serial port is not necessary, and also users do not need to care about the communication protocol.

Output Information Configuration

Description: The default configuration of the sensor is to output the sensing results only in ASCII code string format, and modification is not supported temporarily.

Human body induction result output: ASCII code string format

Description:

• The string information starts with "$" and ends with "*". Multiple parameters are separated by ",", and placeholder parameters(reserved) are replaced by spaces.
• The sensing result of the "Human Sensor" is output at a data refresh rate of 1Hz by default.

Response: $JYBSS,par1,par2,par3,par4*

Sensor Detection Area Configuration

Description:

• The module configures the sensing area as 128 equal parts by default, each equal part is about 15cm. The configuration parameters are selected from 0~127, as the index of the distance value in the sensing area.
• The sensing area allows configuration of 4 segments, the configuration values of the 4 segments must be configured in order from small to large, and cannot contain each other.

Command: detRangeCfg par1 parA_s parA_e parB_s parB_e parC_s parC_e parD_s parD_e

Note: Multiply the start or end value index of the sensing area distance by 15cm, it represents the start or end distance value.

Sensor Output Delay Configuration

Description: configure, when the sensor detects a target, the delay time for the output of the sensing result; after the target disappears, the delay time for the output of the sensing result. By default, when a target detected, the delayed output time is 2.5s; after the target disappears, the delayed output time is 10s.

Command: outputLatency par1 par2 par3

Sensor Start-up Mode Configuration

Description: Configure the sensor to start running immediately after power-on or wait for the start command after power-on. The former is set by default.

Command: sensorCfgStart par1

Sensor Start Control

Description:

**- When the sensor is in an unstarted state and there are no set parameters to be saved, start the sensor to run.

• Through the sensorCfgStart command, when the sensor is configured to start running immediately after power-on, there is no need to execute the sensorStart command to start running.**

Command: sensorStart

Sensor Reset Control

Description: Reset the sensor by software

Command: resetSystem

Sensor Stop Control

Description: Stop the sensor when it is running.

Commands: sensorStop

Configuration Save Parameter

Description: When the sensor parameters are reconfigured through the UART and have not been saved, this command saves the new configuration parameters to the sensor Flash

Command: saveCfg par1 par2 par3 par4

Save the configuration parameters to the non-power-loss memory unit, command: saveCfg 0x45670123 0xCDEF89AB 0x956128C6 0xDF54AC89

Factory reset

Description: Restore the current configuration parameter value of the sensor to the factory default value.

Command: factoryReset par1 par2 par3 par4

Restore configuration parameters to factory default values, command: factoryReset 0x45670123 0xCDEF89AB 0x956128C6 0xDF54AC89

API Description

/**
      @brief Constructor 
      @param Stream  Software serial port interface 
    */
    DFRobot_mmWave_Radar(Stream *s);

    /**
      @brief  Configure sensor detection area  
      @param parA_s The sensing area distance starting value of the first segment, unit: m  
      @param parA_e The sensing area distance ending value of the first segment, unit: m(Must be greater than the starting value of the current sensing area)
    */
    void DetRangeCfg(float parA_s, float parA_e);


    /**
      @brief  Configure sensor detection area 
      @param parA_s The sensing area distance starting value of the first segment, unit: m
      @param parA_e The sensing area distance ending value of the first segment, unit: m(Must greater than the starting value of the current sensing area)
      @param parB_s The sensing area distance starting value of the second segment, unit: m(Must be greater than the ending value of the previous segment sensing area) 
      @param parB_e The sensing area ending value of the second segment, unit: m(Must be greater than the starting value of the current sensing area)
    */
    void DetRangeCfg(float parA_s, float parA_e, float parB_s, float parB_e);


    /**
      @brief  Configure sensor detection area 
      @param parA_s The sensing area distance starting value of the first segment, unit: m
      @param parA_e The sensing area distance ending value of the first segment, unit: m (Must be greater than the starting value of the current sensing area)
      @param parB_s The sensing area distance starting value of the second segment, unit: m(Must be greater than the ending value of the previous segment sensing area)
      @param parB_e The sensing area distance ending value of the second segment, unit: m(Must be greater than the starting value of the current sensing area)
      @param parC_s The sensing area distance starting value of the third segment, unit: m(Must be greater than the ending value of the previous segment sensing area)
      @param parC_e The sensing area distance ending value of the third segment, unit: m(Must be greaer than the starting value of the current sensing area)
    */
    void DetRangeCfg(float parA_s, float parA_e, float parB_s, float parB_e, float parC_s, float parC_e);


    /**
      @brief  Configure sensor detection area 
      @param parA_s The sensing area distance starting value of the first segment, unit: m 
      @param parA_e The sensing area distance ending value of the first segment, unit: m(Must be greater than the starting value of the current sensing area)
      @param parB_s The sensing area distance starting value of the second segment, unit: m(Must be greatet than the ending value of the previous segment sensing area)
      @param parB_e The sensing area distance ending value of the second segment, unit: m(Must be greater than the starting value of the current sensing area)
      @param parC_s The sensing area distance starting value of the third segment, unit: m(Must be greater than the ending value of the previous segment sensing area)
      @param parC_e The sensing area distance ending value of the third segment, unit: m(Must be greater than the starting value of the current sensing area)
      @param parD_s The sensing area distance starting value of the fourth segment, unit: m(Must be greater than the ending value of the previous segment sensing area)
      @param parD_e The sensing area ditance ending value of the fourth segment, unit: m(Must be greater than the starting value of the current sensin area)
    */
    void DetRangeCfg(float parA_s, float parA_e, float parB_s, float parB_e, float parC_s, float parC_e, float parD_s, float parD_e);


    /**
      @brief  Read whether there is people or object moving in the sensing area
      @return  Returning true means that there is people or animal moving in the detection range; false means the opposite
    */
    bool readPresenceDetection(void);


    /**
      @brief  Configure sensor output delay time 
      @param par1 When a target detected, delay the output time of sensing result, range：0~1638.375, unit: s 
      @param par2 When the target disappears, delay the output time of sensing result, range: 0~1638.375, unit: s
    */
    void OutputLatency(float par1, float par2);


    /**
      @brief  Restore the sensor current configuration to the factory settings. 
    */
    void factoryReset(void);