1
0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2024-12-29 04:50:03 +01:00
RIOT/tests/periph_i2c/README.md

25 lines
967 B
Markdown
Raw Normal View History

2014-10-09 10:40:31 +02:00
Expected result
===============
This test enables you to test all available low-level I2C functions using the shell.
Consult the `help` shell command for available actions.
2014-10-09 10:40:31 +02:00
Background
==========
Test for the low-level I2C driver. Can be run manually or using python script interface.
Glossary
==========
DEV - The I2C device number, this is usually 0.
Consult the board header file for more information.</br>
ADDR - The address of the slave I2C device, this is usually the sensor.
Information on the slave address should be found in the sensor datasheet.</br>
REG - The register of the slave device/sensor.
Not all sensors follow this access method.
A I2C_NOSTOP (0x04) may be needed.</br>
LEN - The length to read or write.</br>
FLAG - Flags set for the I2C, more information is available in driver/include/periph/i2c.h
_note: Automated tests can be found in the
[RobotFW-tests](https://github.com/RIOT-OS/RobotFW-tests/tree/master/tests/periph_i2c)
repository_