XM125 I2C Presence Detector

User Guide
 XM125 I2 C Presence Detector

XM125 I2 C Presence Detector

User Guide

Author: Acconeer AB

Version:a121-v1.6.0

Acconeer AB April 19, 2024

© 2024 by Acconeer AB - All rights reserved Page 1 of 24

 XM125 I2 C Presence Detector

Contents

1 Acconeer SDK Documentation Overview 4

2 I2 C Presence Detector Application 5

2.1 I2 C Address Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
2.2 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
2.2.1 Read Detector Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
2.2.2 Writing a command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
2.2.3 Setup and Start Detector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
2.2.4 Stop and Restart Detector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
2.3 Advanced Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
2.3.1 Debug UART logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
2.3.2 Reset Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
2.3.3 Presence Detection on GPIO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

3 Register Protocol 7
3.1 I2 C Slave Address . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
3.2 Protocol Byte Order . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
3.2.1 I2 C Write Register(s) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
3.2.2 I2 C Read Register(s) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
3.3 Register Protocol - Low Power Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
3.3.1 I2 C Communication with Low Power Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

4 File Structure 10

5 Embedded Host Example 10

5.1 Register Read/Write functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
5.2 Detector setup functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

6 Registers 15
6.1 Register Map . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
6.2 Register Descriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
6.2.1 Version . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
6.2.2 Protocol Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
6.2.3 Measure Counter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
6.2.4 Detector Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
6.2.5 Presence Result . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
6.2.6 Presence Distance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
6.2.7 Intra Presence Score . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
6.2.8 Inter Presence Score . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
6.2.9 Presence Actual Frame Rate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
6.2.10 Sweeps Per Frame . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
6.2.11 Inter Frame Presence Timeout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
6.2.12 Inter Phase Boost Enabled . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
6.2.13 Intra Detection Enabled . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
6.2.14 Inter Detection Enabled . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
6.2.15 Frame Rate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
6.2.16 Intra Detection Threshold . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
6.2.17 Inter Detection Threshold . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
6.2.18 Inter Frame Deviation Time Const . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
6.2.19 Inter Frame Fast Cutoff . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
6.2.20 Inter Frame Slow Cutoff . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
6.2.21 Intra Frame Time Const . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
6.2.22 Intra Output Time Const . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
6.2.23 Inter Output Time Const . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
6.2.24 Auto Profile Enabled . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
6.2.25 Auto Step Length Enabled . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
6.2.26 Manual Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
6.2.27 Manual Step Length . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
6.2.28 Start . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

© 2024 by Acconeer AB - All rights reserved Page 2 of 24

 XM125 I2 C Presence Detector

6.2.29 End . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
6.2.30 Reset Filters On Prepare . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
6.2.31 Hwaas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
6.2.32 Automatic Subsweeps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
6.2.33 Signal Quality . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
6.2.34 Detection On Gpio . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
6.2.35 Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
6.2.36 Application Id . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

7 Disclaimer 24

© 2024 by Acconeer AB - All rights reserved Page 3 of 24

 XM125 I2 C Presence Detector

1 Acconeer SDK Documentation Overview

To better understand what SDK document to use, a summary of the documents are shown in the table below.

Table 1: SDK document overview.

Name Description When to use

RSS API documentation (html)
- RSS application implementation
rss api The complete C API documentation.
- Understanding RSS API functions
User guides (PDF)
Describes the Acconeer assembly - Bring-up of HW/SW
A121 Assembly Test
test functionality. - Production test implementation
A121 Breathing Describes the functionality of the - Working with the Breathing
Reference Application Breathing Reference Application. Reference Application
Describes usage and algorithms
A121 Distance Detector - Working with the Distance Detector
of the Distance Detector.
Describes how to implement each
- SW implementation of
A121 SW Integration integration function needed to use
custom HW integration
the Acconeer sensor.
Describes usage and algorithms
A121 Presence Detector - Working with the Presence Detector
of the Presence Detector.
A121 Smart Presence Describes the functionality of the - Working with the Smart Presence
Reference Application Smart Presence Reference Application. Reference Application
Describes usage of the Sparse IQ
A121 Sparse IQ Service - Working with the Sparse IQ Service
Service.
A121 Tank Level Describes the functionality of the - Working with the Tank Level
Reference Application Tank Level Reference Application. Reference Application
A121 Touchless Button Describes the functionality of the - Working with the Touchless Button
Reference Application Touchless Button Reference Application. Reference Application
A121 Parking Describes the functionality of the - Working with the Parking
Reference Application Parking Reference Application. Reference Application
Describes the flow of taking an
A121 STM32CubeIDE Acconeer SDK and integrate into - Using STM32CubeIDE
STM32CubeIDE.
Describes how to develop for
A121 Raspberry Pi Software - Working with Raspberry Pi
Raspberry Pi.
Describes how to develop for - Working with Ripple
A121 Ripple
Ripple. on Raspberry Pi
Describes how to develop for
XM125 Software - Working with XM125
XM125.
Describes how to develop for
XM126 Software - Working with XM126
XM126.
Describes the functionality of the - Working with the
I2C Distance Detector
I2C Distance Detector Application. I2C Distance Detector Application
Describes the functionality of the - Working with the
I2C Presence Detector
I2C Presence Detector Application. I2C Presence Detector Application
Describes the functionality of the - Working with the
I2C Breathing Reference Application
I2C Breathing Reference Application. I2C Breathing Reference Application
Handbook (PDF)
Describes different aspects of the
- To understand the Acconeer sensor
Handbook Acconeer offer, for example radar
- Use case evaluation
principles and how to configure
Readme (txt)
Various target specific information
README - After SDK download
and links

© 2024 by Acconeer AB - All rights reserved Page 4 of 24

 XM125 I2 C Presence Detector

2 I2 C Presence Detector Application

The I2 C Presence Detector is an application that implements the Acconeer Presence Detector with a register based I2 C
interface.
The functionality of the presence detector is described in A121 Presence Detector User Guide.pdf or in Acconeer
Docs.
Note: Some of the registers like start and end have a different unit in the I2 C Presence Detector, millimeters instead of
meters, to make it easier to handle the register values as integers.

2.1 I2 C Address Configuration

The device has a configurable I2 C address. The address is selected depending on the state of the I2C ADDR pin according
to the following table:
Connected to GND 0x51
Not Connected 0x52
Connected to VIN 0x53

2.2 Usage
The module must be ready before the host starts I2 C communication.
The module will enter ready state by following this procedure.
• Set WAKE UP pin of the module HIGH.
• Wait for module to be ready, this is indicated by the MCU INT pin being HIGH.
• Start I2 C communication.
The module will enter a low power state by following this procedure.
• Wait for module to be ready, this is indicated by the MCU INT pin being HIGH.
• Set the WAKE UP pin of the module LOW.
• Wait for ready signal, the MCU INT pin, to become LOW.

2.2.1 Read Detector Status

The status of the module can be acquired by reading the Detector Status register, The most important bits are the Busy
and Error bits.
The Busy bit must not be set when a new command is written. If any of the Error bits are set the module will not accept
any commands except the RESET MODULE command.

2.2.2 Writing a command

A command is written to the Command register. When a command is written the Busy bit in the Detector Status register
is set and it will be cleared automatically when the command has finished.

2.2.3 Setup and Start Detector

Before the module can perform presence detection it must be configured. The following steps is an example of how this
can be achieved.
Note: The configuration parameters can not be changed after a APPLY CONFIGURATION command. If
reconfiguration is needed the module must be restarted by writing RESET MODULE to the Command register.
• Power on module
• Read Detector Status register and verify that neither Busy nor Error bits are set.
• Write configuration to configuration registers, for example Start register and End register.
• Write APPLY CONFIGURATION to Command register.
• Poll Detector Status until Busy bit is cleared.

© 2024 by Acconeer AB - All rights reserved Page 5 of 24

 XM125 I2 C Presence Detector

• Verify that no Error bits are set in the Detector Status register.
• Write START DETECTOR to Command register.
• Poll Detector Status until Busy bit is cleared.
• Verify that no Error bits are set in the Detector Status register.
• Read Detector Result register
– If PRESENCE DETECTED is set presence is currently detected.
– If PRESENCE DETECTED STICKY is set presence has been detected since last read.
– If DETECTOR ERROR is set an error has occurred, restart module with the RESET MODULE command.
– If presence was detected, the presence distance can be read in the Presence Distance register.

2.2.4 Stop and Restart Detector

The detector can be stopped and restarted.
The following steps is an example of how to stop the detector.
• Read Detector Status register and verify that neither Busy nor Error bits are set.
• Write STOP DETECTOR to Command register.
• Poll Detector Status until Busy bit is cleared.
• Verify that no Error bits are set in the Detector Status register.
The following steps is an example of how to re-start the detector.
• Read Detector Status register and verify that neither Busy nor Error bits are set.
• Write START DETECTOR to Command register.
• Poll Detector Status until Busy bit is cleared.
• Verify that no Error bits are set in the Detector Status register.

2.3 Advanced Usage

2.3.1 Debug UART logs
UART logging can be enabled on the DEBUG UART by writing ENABLE UART LOGS to the Command
register.
The detector configuration can be logged on the UART by writing LOG CONFIGURATION to the Command
register.
UART logging can be disabled by writing DISABLE UART LOGS to the Command register.

2.3.2 Reset Module

The module can be restarted by writing RESET MODULE to the Command register.
After the restart the detector must be configured again.

2.3.3 Presence Detection on GPIO

The I2 C Presence Detector can be configured to set MISC GPIO0 pin HIGH when presence is detected, and LOW when
presence is not detected. To enable presence detection on GPIO, write 1 to the Detection On Gpio register. To disable
presence detection on GPIO, write 0 to the Detection On Gpio register.

© 2024 by Acconeer AB - All rights reserved Page 6 of 24

 XM125 I2 C Presence Detector

3 Register Protocol

3.1 I2 C Slave Address

The default slave address is 0x52.

3.2 Protocol Byte Order

Both register address, 16-bit, and register data, 32-bit, are sent in big endian byte order.

3.2.1 I2 C Write Register(s)

A write register operation consists of an I2 C write of two address bytes and four data bytes for each register to write.
Several registers can be written in the same I2 C transaction, the register address will be incremented by one for each four
data bytes.
Example 1: Writing six bytes will write one register, two address bytes and four data bytes.
Example 2: Writing 18 bytes will write four registers, two address bytes and 16 data bytes.
Example operation, write 0x11223344 to address 0x0025.
Description Data
I2 C Start Condition
Slave Address + Write 0x52 + W
Address to slave [15:8] 0x00
Address to slave [7:0] 0x25
Data to slave [31:24] 0x11
Data to slave [23:16] 0x22
Data to slave [15:8] 0x33
Data to slave [7:0] 0x44
I2 C Stop Condition

Example Waveform: Write register with address 0x0100, the data sent from the master to the slave is 0x00000001

3.2.2 I2 C Read Register(s)

A read register operation consists of an I2 C write of two address bytes followed by an I2 C read of four data bytes for each
register to read. Several registers can be read in the same I2 C transaction, the register address will be incremented by one
for each four data bytes.
Example 1: Writing two bytes and reading four bytes will read one register.

© 2024 by Acconeer AB - All rights reserved Page 7 of 24

 XM125 I2 C Presence Detector

Example 2: Writing two bytes and reading 16 bytes will read four registers.
Example operation, read 0x12345678 from address 0x0003.
Description Data
I2 C Start Condition
Slave Address + Write 0x52 + W
Address to slave [15:8] 0x00
Address to slave [7:0] 0x03
I2 C Stop Condition
I2 C Start Condition
Slave Address + Read 0x52 + R
Data from slave [31:24] 0x12
Data from slave [23:16] 0x34
Data from slave [15:8] 0x56
Data from slave [7:0] 0x78
I2 C Stop Condition

Example Waveform: Read register with address 0, the data sent from the slave to the master is 0x00010001

© 2024 by Acconeer AB - All rights reserved Page 8 of 24

 XM125 I2 C Presence Detector

3.3 Register Protocol - Low Power Mode

3.3.1 I2 C Communication with Low Power Mode
Low power example

Low Power Example: Magnification of Wake up, Setup Presence Detector, Power down

© 2024 by Acconeer AB - All rights reserved Page 9 of 24

 XM125 I2 C Presence Detector

4 File Structure

The I2 C Presence Detector application consists of the following files.

Src
applications
i2c
acc reg protocol.c
presence reg protocol access.c
presence reg protocol.c
i2c application system stm32.c
i2c presence detector.c
Inc
acc reg protocol.h
presence reg protocol.h
i2c application system.h
i2c presence detector.h
• acc reg protocol.c A generic protocol handler implementation.
• presence reg protocol.c The specific register protocol setup for the I2 C Presence Detector.
• presence reg protocol access.c The register read and write access functions for the I2 C Presence Detector.
• i2c application system stm32.c System functions, such as I2 C handling, GPIO control and low power state
• i2c presence detector.c The I2 C Presence Detector application.

5 Embedded Host Example

This is an example implementation of the host read and write register functions using the STM32 SDK.

5.1 Register Read/Write functions

# include < inttypes .h >

# include < stdbool .h >
# include < stdint .h >

# include "presence_reg_protocol . h "

// Use 1000 ms timeout

# define I2C_TIMEOUT_MS 1000

// The STM32 uses the i2c address shifted one position

// to the left (0 x52 becomes 0 xa4 )
# define I2C_ADDR 0 xa4

// The register address length is two bytes

# define RE G_ AD DR ES S_ LE NG TH 2

// The register data length is four bytes

# define REG_DATA_LENGTH 4

/* *
* @brief Read register value over I2C
*
* @param [ in ] reg_addr The register address to read
* @param [ out ] reg_data The read register data
* @returns true if successful
*/
bool read_register ( uint16_t reg_addr , uint32_t * reg_data )
{

© 2024 by Acconeer AB - All rights reserved Page 10 of 24

 XM125 I2 C Presence Detector

HAL_ Status TypeDe f status = HAL_OK ;

uint8_t transmit_data [ RE G_ AD DRE SS _L EN GT H ];

transmit_data [0] = ( reg_addr >> 8) & 0 xff ;

transmit_data [1] = ( reg_addr >> 0) & 0 xff ;

status = H A L _ I 2 C _ M a s t e r _ T r a n s m i t (& STM32_I2C_HANDLE , I2C_ADDR ,

transmit_data , REG_ADDRESS_LENGTH ,
I2C_TIMEOUT_MS ) ;
if ( status != HAL_OK )
{
return false ;
}

uint8_t receive_data [ REG_DATA_LENGTH ];

status = H A L _ I 2 C _ M a s t e r _ R e c e i v e (& STM32_I2C_HANDLE , I2C_ADDR ,

receive_data , REG_DATA_LENGTH ,
I2C_TIMEOUT_MS ) ;
if ( status != HAL_OK )
{
return false ;
}

// Convert bytes to uint32_t

uint32_t val = receive_data [0];
val = val << 8;
val |= receive_data [1];
val = val << 8;
val |= receive_data [2];
val = val << 8;
val |= receive_data [3];
* reg_data = val ;

return true ;
}

/* *
* @brief Write register value over I2C
*
* @param [ in ] reg_addr The register address to write
* @param [ in ] reg_data The register data to write
* @returns true if successful
*/
bool write_register ( uint16_t reg_addr , uint32_t reg_data )
{
HAL_ Status TypeDe f status = HAL_OK ;

uint8_t transmit_data [ RE G_ AD DRE SS _L EN GT H + REG_DATA_LENGTH ];

// Convert uint16_t address to bytes

transmit_data [0] = ( reg_addr >> 8) & 0 xff ;
transmit_data [1] = ( reg_addr >> 0) & 0 xff ;
// Convert uint32_t reg_data to bytes
transmit_data [2] = ( reg_data >> 24) & 0 xff ;
transmit_data [3] = ( reg_data >> 16) & 0 xff ;
transmit_data [4] = ( reg_data >> 8) & 0 xff ;
transmit_data [5] = ( reg_data >> 0) & 0 xff ;

© 2024 by Acconeer AB - All rights reserved Page 11 of 24

 XM125 I2 C Presence Detector

status = H A L _ I 2 C _ M a s t e r _ T r a n s m i t (& STM32_I2C_HANDLE , I2C_ADDR ,

transmit_data ,
RE G_ AD DR ES S_ LE NG TH + REG_DATA_LENGTH ,
I2C_TIMEOUT_MS ) ;
if ( status != HAL_OK )
{
return false ;
}

return true ;
}

5.2 Detector setup functions

# include " p r e s e n c e _ r e g _ p r o t o c o l . h "

/* *
* @brief Test if configuration of detector is OK
*
* @returns true if successful
*/
bool configuration_ok ( void )
{
uint32_t status = 0
if (! read_register ( PRE SE NC E_ RE G_ DE TE CT OR _ST AT US _A DD RE SS , & status ) )
{
// ERROR
return false ;
}

uint32_t config_ok_mask =
PRESENCE_REG_DETECTOR_STATUS_FIELD_RSS_REGISTER_OK_MASK |
PRESENCE_REG_DETECTOR_STATUS_FIELD_CONFIG_CREATE_OK_MASK |
PRESENCE_REG_DETECTOR_STATUS_FIELD_SENSOR_CREATE_OK_MASK |
PRESENCE_REG_DETECTOR_STATUS_FIELD_SENSOR_CALIBRATE_OK_MASK |
PRESENCE_REG_DETECTOR_STATUS_FIELD_DETECTOR_CREATE_OK_MASK |
PRESENCE_REG_DETECTOR_STATUS_FIELD_DETECTOR_BUFFER_OK_MASK |
PRESENCE_REG_DETECTOR_STATUS_FIELD_SENSOR_BUFFER_OK_MASK |
PRESENCE_REG_DETECTOR_STATUS_FIELD_CONFIG_APPLY_OK_MASK ;

if ( status != config_ok_mask )
{
// ERROR
return false ;
}

return true ;
}

/* *
* @brief Wait for detector not busy
*
* @returns true if successful
*/
bool wait_not_busy ( void )
{
uint32_t status = 0
do

© 2024 by Acconeer AB - All rights reserved Page 12 of 24

 XM125 I2 C Presence Detector

{
if (! read_register ( PRE SE NC E_ RE G_ DE TE CT OR_ ST AT US _A DD RE SS , & status ) )
{
// ERROR
return false ;
}
} while (( status & P R E S E N C E _ R E G _ D E T E C T O R _ S T A T U S _ F I E L D _ B U S Y _ M A S K ) != 0) ;

return true ;
}

bool e x a m p l e _ s e t u p _ a n d _ s t a r t ( void )
{
// Set start at 1000 mm
if (! write_register ( PRESENCE_REG_START_ADDRESS , 1000) )
{
// ERROR
return false ;
}
// Set end at 5000 mm
if (! write_register ( PRESENCE_REG_END_ADDRESS , 5000) )
{
// ERROR
return false ;
}

// Apply configuration
if (! write_register (
PRESENCE_REG_COMMAND_ADDRESS ,
PRESENCE_REG_COMMAND_ENUM_APPLY_CONFIGURATION ))
{
// ERROR
return false ;
}

// Wait for the configuration to be done

if (! wait_not_busy () )
{
// ERROR
return false ;
}

// Test if configration of detector was OK

if (! configuration_ok () )
{
// ERROR
return false ;
}

// Start detector
if (! write_register ( PRESENCE_REG_COMMAND_ADDRESS ,
PRESENCE_REG_COMMAND_ENUM_START_DETECTOR ))
{
// ERROR
return false ;
}

// Wait for command be done

if (! wait_not_busy () )
{

© 2024 by Acconeer AB - All rights reserved Page 13 of 24

 XM125 I2 C Presence Detector

// ERROR
return false ;
}

// Read detector result

uint32_t result ;
if (! read_register ( PRE SE NC E_ RE G_ PR ES EN CE _RE SU LT _A DD RE SS , & result ) )
{
// ERROR
return false ;
}

// Was presence detected ?

bool pre sence_ detect ed = ( result &

P R E S E N C E _ R E G _ P R E S E N C E _ R E S U L T _ F I E L D _ P R E S E N C E _ D E T E C T E D _ M A S K ) != 0;
bool p r e s e n c e _ d e t e c t e d _ s t i c k y = ( result &
P R E S E N C E _ R E G _ P R E S E N C E _ R E S U L T _ F I E L D _ P R E S E N C E _ D E T E C T E D _ S T I C K Y _ M A S K ) !=
0;

// Print peak if found

if ( pr esence _detec ted || p r e s e n c e _ d e t e c t e d _ s t i c k y )
{
uint32_t p r e s e n c e _ d i s t a n c e _ m m ;
if ( read_register ( P RE S E NC E _ RE G _ PR E S EN C E _D I S TA N C E_ A D DR E S S , &
presence_distance_mm ))
{
printf ( " Presence detected at distance : % " PRIu32 " mm \ n " ,
presence_distance_mm );
}
else
{
// ERROR
return false ;
}
}
else
{
printf ( " No presence detected \ n " ) ;
}

return true ;
}

© 2024 by Acconeer AB - All rights reserved Page 14 of 24

 XM125 I2 C Presence Detector

6 Registers

6.1 Register Map

Address Register Name Type

0x0000 Version Read Only
0x0001 Protocol Status Read Only
0x0002 Measure Counter Read Only
0x0003 Detector Status Read Only
0x0010 Presence Result Read Only
0x0011 Presence Distance Read Only
0x0012 Intra Presence Score Read Only
0x0013 Inter Presence Score Read Only
0x0020 Presence Actual Frame Rate Read Only
0x0040 Sweeps Per Frame Read / Write
0x0041 Inter Frame Presence Timeout Read / Write
0x0042 Inter Phase Boost Enabled Read / Write
0x0043 Intra Detection Enabled Read / Write
0x0044 Inter Detection Enabled Read / Write
0x0045 Frame Rate Read / Write
0x0046 Intra Detection Threshold Read / Write
0x0047 Inter Detection Threshold Read / Write
0x0048 Inter Frame Deviation Time Const Read / Write
0x0049 Inter Frame Fast Cutoff Read / Write
0x004a Inter Frame Slow Cutoff Read / Write
0x004b Intra Frame Time Const Read / Write
0x004c Intra Output Time Const Read / Write
0x004d Inter Output Time Const Read / Write
0x004e Auto Profile Enabled Read / Write
0x004f Auto Step Length Enabled Read / Write
0x0050 Manual Profile Read / Write
0x0051 Manual Step Length Read / Write
0x0052 Start Read / Write
0x0053 End Read / Write
0x0054 Reset Filters On Prepare Read / Write
0x0055 Hwaas Read / Write
0x0056 Automatic Subsweeps Read / Write
0x0057 Signal Quality Read / Write
0x0080 Detection On Gpio Read / Write
0x0100 Command Write Only
0xffff Application Id Read Only

6.2 Register Descriptions

6.2.1 Version

Address 0x0000
Access Read Only
Register Type field
Description Get the RSS version.

Bitfield Pos Width Mask

MAJOR 16 16 0xffff0000
MINOR 8 8 0x0000ff00
PATCH 0 8 0x000000ff

MAJOR - Major version number

© 2024 by Acconeer AB - All rights reserved Page 15 of 24

 XM125 I2 C Presence Detector

MINOR - Minor version number

PATCH - Patch version number

6.2.2 Protocol Status

Address 0x0001
Access Read Only
Register Type field
Description Get protocol error flags.

Bitfield Pos Width Mask

PROTOCOL STATE ERROR 0 1 0x00000001
PACKET LENGTH ERROR 1 1 0x00000002
ADDRESS ERROR 2 1 0x00000004
WRITE FAILED 3 1 0x00000008
WRITE TO READ ONLY 4 1 0x00000010

PROTOCOL STATE ERROR - Protocol state error

PACKET LENGTH ERROR - Packet length error
ADDRESS ERROR - Register address error
WRITE FAILED - Write register failed
WRITE TO READ ONLY - Write to read only register

6.2.3 Measure Counter

Address 0x0002
Access Read Only
Register Type uint
Description Get the measure counter, the number of measurements performed since restart.

6.2.4 Detector Status

Address 0x0003
Access Read Only
Register Type field
Description Get detector status flags.

Bitfield Pos Width Mask

RSS REGISTER OK 0 1 0x00000001
CONFIG CREATE OK 1 1 0x00000002
SENSOR CREATE OK 2 1 0x00000004
SENSOR CALIBRATE OK 3 1 0x00000008
DETECTOR CREATE OK 4 1 0x00000010
DETECTOR BUFFER OK 5 1 0x00000020
SENSOR BUFFER OK 6 1 0x00000040
CONFIG APPLY OK 7 1 0x00000080
RSS REGISTER ERROR 16 1 0x00010000
CONFIG CREATE ERROR 17 1 0x00020000
SENSOR CREATE ERROR 18 1 0x00040000
SENSOR CALIBRATE ERROR 19 1 0x00080000
DETECTOR CREATE ERROR 20 1 0x00100000
DETECTOR BUFFER ERROR 21 1 0x00200000
SENSOR BUFFER ERROR 22 1 0x00400000

© 2024 by Acconeer AB - All rights reserved Page 16 of 24

 XM125 I2 C Presence Detector

CONFIG APPLY ERROR 23 1 0x00800000

DETECTOR ERROR 28 1 0x10000000
BUSY 31 1 0x80000000

RSS REGISTER OK - RSS register OK

CONFIG CREATE OK - Configuration create OK
SENSOR CREATE OK - Sensor create OK
SENSOR CALIBRATE OK - Sensor calibrate OK
DETECTOR CREATE OK - Detector create OK
DETECTOR BUFFER OK - Detector get buffer size OK
SENSOR BUFFER OK - Memory allocation of sensor buffer OK
CONFIG APPLY OK - Detector configuration apply OK
RSS REGISTER ERROR - RSS register error
CONFIG CREATE ERROR - Configuration create error
SENSOR CREATE ERROR - Sensor create error
SENSOR CALIBRATE ERROR - Sensor calibrate error
DETECTOR CREATE ERROR - Detector create error
DETECTOR BUFFER ERROR - Detector get buffer size error
SENSOR BUFFER ERROR - Memory allocation of sensor buffer error
CONFIG APPLY ERROR - Detector configuration apply error
DETECTOR ERROR - Detector error occured, restart necessary
BUSY - Detector busy

6.2.5 Presence Result

Address 0x0010
Access Read Only
Register Type field
Description The result from the presence detector.

Bitfield Pos Width Mask

PRESENCE DETECTED 0 1 0x00000001
PRESENCE DETECTED STICKY 1 1 0x00000002
DETECTOR ERROR 15 1 0x00008000
TEMPERATURE 16 16 0xffff0000

PRESENCE DETECTED - Presence detected

PRESENCE DETECTED STICKY - Presence detected, sticky bit with clear on read
DETECTOR ERROR - The presence detector failed
TEMPERATURE - Temperature in sensor during measurement (in degree Celsius). Note that it has poor absolute
accuracy and should only be used for relative temperature measurements.

6.2.6 Presence Distance

Address 0x0011
Access Read Only

© 2024 by Acconeer AB - All rights reserved Page 17 of 24

 XM125 I2 C Presence Detector

Register Type uint

Unit mm
Description The distance, in millimeters, for the detected presence

6.2.7 Intra Presence Score

Address 0x0012
Access Read Only
Register Type uint
Description A measure of the amount of fast motion detected.

6.2.8 Inter Presence Score

Address 0x0013
Access Read Only
Register Type uint
Description A measure of the amount of slow motion detected.

6.2.9 Presence Actual Frame Rate

Address 0x0020
Access Read Only
Register Type uint
Unit mHz
Description The actual frame rate of the presence detector.

6.2.10 Sweeps Per Frame

Address 0x0040
Access Read / Write
Register Type uint
Description The number of sweeps that will be captured in each frame (measurement).
Default Value 16

6.2.11 Inter Frame Presence Timeout

Address 0x0041
Access Read / Write
Register Type uint
Description Number of seconds the inter-frame presence score needs to decrease before
exponential scaling starts for faster decline. Should be between 0 and 30 where 0
means no timeout. Note:
Default Value 3

6.2.12 Inter Phase Boost Enabled

Address 0x0042
Access Read / Write
Register Type bool
Description Enable to increase detection of slow motions by utilizing the phase information in the
Sparse IQ data.
Default Value False

© 2024 by Acconeer AB - All rights reserved Page 18 of 24

 XM125 I2 C Presence Detector

6.2.13 Intra Detection Enabled

Address 0x0043
Access Read / Write
Register Type bool
Description Enable to detect faster movements inside frames.
Default Value True

6.2.14 Inter Detection Enabled

Address 0x0044
Access Read / Write
Register Type bool
Description Enable to detect slower movements between frames.
Default Value True

6.2.15 Frame Rate

Address 0x0045
Access Read / Write
Register Type uint
Unit mHz
Description The presence detector frame rate. Note: This value is a factor 1000 larger than the
RSS value.
Default Value 12000

6.2.16 Intra Detection Threshold

Address 0x0046
Access Read / Write
Register Type uint
Description The threshold for detecting faster movements inside frames. Note: This value is a
factor 1000 larger than the RSS value.
Default Value 1300

6.2.17 Inter Detection Threshold

Address 0x0047
Access Read / Write
Register Type uint
Description This is the threshold for detecting slower movements between frames. Note: This
value is a factor 1000 larger than the RSS value.
Default Value 1000

6.2.18 Inter Frame Deviation Time Const

Address 0x0048
Access Read / Write
Register Type uint
Unit ms
Description The time constant of the low pass filter for the inter-frame deviation between fast and
slow. Note: This value is a factor 1000 larger than the RSS value.
Default Value 500

© 2024 by Acconeer AB - All rights reserved Page 19 of 24

 XM125 I2 C Presence Detector

6.2.19 Inter Frame Fast Cutoff

Address 0x0049
Access Read / Write
Register Type uint
Unit mHz
Description The cutoff frequency of the low pass filter for the fast filtered absolute sweep mean.
Note: This value is a factor 1000 larger than the RSS value.
Default Value 6000

6.2.20 Inter Frame Slow Cutoff

Address 0x004a
Access Read / Write
Register Type uint
Unit mHz
Description The cutoff frequency of the low pass filter for the slow filtered absolute sweep mean.
Note: This value is a factor 1000 larger than the RSS value.
Default Value 200

6.2.21 Intra Frame Time Const

Address 0x004b
Access Read / Write
Register Type uint
Unit ms
Description The time constant for the depthwise filtering in the intra-frame part. Note: This value
is a factor 1000 larger than the RSS value.
Default Value 150

6.2.22 Intra Output Time Const

Address 0x004c
Access Read / Write
Register Type uint
Unit ms
Description The time constant for the output in the intra-frame part. Note: This value is a factor
1000 larger than the RSS value.
Default Value 300

6.2.23 Inter Output Time Const

Address 0x004d
Access Read / Write
Register Type uint
Unit ms
Description The time constant for the output in the inter-frame part. Note: This value is a factor
1000 larger than the RSS value.
Default Value 2000

6.2.24 Auto Profile Enabled

Address 0x004e
Access Read / Write
Register Type bool

© 2024 by Acconeer AB - All rights reserved Page 20 of 24

 XM125 I2 C Presence Detector

Description Enable/Disable automatic selection of profile based on start point of measurement.

Default Value True

6.2.25 Auto Step Length Enabled

Address 0x004f
Access Read / Write
Register Type bool
Description Enable/Disable automatic selection of step length based on the profile.
Default Value True

6.2.26 Manual Profile

Address 0x0050
Access Read / Write
Register Type enum
Description The profile to use. The profile will only be used if profile auto selection was disabled.
Default Value PROFILE4

Enum Value
PROFILE1 1
PROFILE2 2
PROFILE3 3
PROFILE4 4
PROFILE5 5

PROFILE1 - Profile 1
PROFILE2 - Profile 2
PROFILE3 - Profile 3
PROFILE4 - Profile 4
PROFILE5 - Profile 5

6.2.27 Manual Step Length

Address 0x0051
Access Read / Write
Register Type uint
Description The number of steps between each data point. The manual step length will only be
used if step length auto selection was disabled.
Default Value 72

6.2.28 Start

Address 0x0052
Access Read / Write
Register Type uint
Unit mm
Description The start point of measurement interval in millimeters. Note: This value is a factor
1000 larger than the RSS value.
Default Value 300

© 2024 by Acconeer AB - All rights reserved Page 21 of 24

 XM125 I2 C Presence Detector

6.2.29 End

Address 0x0053
Access Read / Write
Register Type uint
Unit mm
Description The end point of measurement interval in millimeters. Note: This value is a factor
1000 larger than the RSS value.
Default Value 2500

6.2.30 Reset Filters On Prepare

Address 0x0054
Access Read / Write
Register Type bool
Description Enable/Disable reset of the presence filters during start/restart.
Default Value True

6.2.31 Hwaas

Address 0x0055
Access Read / Write
Register Type uint
Description The hardware accelerated average samples (HWAAS).
Default Value 32

6.2.32 Automatic Subsweeps

Address 0x0056
Access Read / Write
Register Type bool
Description Enable/Disable use of subsweeps.
Default Value True

6.2.33 Signal Quality

Address 0x0057
Access Read / Write
Register Type uint
Description Signal quality.
Default Value 15000

6.2.34 Detection On Gpio

Address 0x0080
Access Read / Write
Register Type bool
Description Output presence detection on generic gpio
Default Value False

6.2.35 Command

Address 0x0100
Access Write Only

© 2024 by Acconeer AB - All rights reserved Page 22 of 24

 XM125 I2 C Presence Detector

Register Type enum

Description Execute command.

Enum Value
APPLY CONFIGURATION 1
START DETECTOR 2
STOP DETECTOR 3
ENABLE UART LOGS 32
DISABLE UART LOGS 33
LOG CONFIGURATION 34
RESET MODULE 1381192737

APPLY CONFIGURATION - Apply the configuration

START DETECTOR - Start the presence detector
STOP DETECTOR - Stop the presence detector
ENABLE UART LOGS - DEBUG: Enable UART Logs
DISABLE UART LOGS - DEBUG: Disable UART Logs
LOG CONFIGURATION - DEBUG: Print detector configuration to UART
RESET MODULE - Reset module, needed to make a new configuration

6.2.36 Application Id

Address 0xffff
Access Read Only
Register Type enum
Description The application id register.

Enum Value
DISTANCE DETECTOR 1
PRESENCE DETECTOR 2
REF APP BREATHING 3

DISTANCE DETECTOR - Distance Detector Application

PRESENCE DETECTOR - Presence Detector Application
REF APP BREATHING - Breathing Reference Application

© 2024 by Acconeer AB - All rights reserved Page 23 of 24

 XM125 I2 C Presence Detector

7 Disclaimer

The information herein is believed to be correct as of the date issued. Acconeer AB (“Acconeer”) will not be responsible
for damages of any nature resulting from the use or reliance upon the information contained herein. Acconeer makes no
warranties, expressed or implied, of merchantability or fitness for a particular purpose or course of performance or usage
of trade. Therefore, it is the user’s responsibility to thoroughly test the product in their particular application to
determine its performance, efficacy and safety. Users should obtain the latest relevant information before placing orders.

Unless Acconeer has explicitly designated an individual Acconeer product as meeting the requirement of a particular
industry standard, Acconeer is not responsible for any failure to meet such industry standard requirements.

Unless explicitly stated herein this document Acconeer has not performed any regulatory conformity test. It is the user’s
responsibility to assure that necessary regulatory conditions are met and approvals have been obtained when using the
product. Regardless of whether the product has passed any conformity test, this document does not constitute any
regulatory approval of the user’s product or application using Acconeer’s product.

Nothing contained herein is to be considered as permission or a recommendation to infringe any patent or any other
intellectual property right. No license, express or implied, to any intellectual property right is granted by Acconeer
herein.

Acconeer reserves the right to at any time correct, change, amend, enhance, modify, and improve this document and/or
Acconeer products without notice.

This document supersedes and replaces all information supplied prior to the publication hereof.

© 2024 by Acconeer AB - All rights reserved Page 24 of 24