63 lines
1.8 KiB
ReStructuredText
63 lines
1.8 KiB
ReStructuredText
.. |I2C| replace:: I\ :sup:`2`\ C
|
|
|
|
I2C Library
|
|
===========
|
|
|
|
:Version: 6.2.0
|
|
:Vendor: XMOS
|
|
|
|
Summary
|
|
-------
|
|
|
|
A software defined, industry-standard, |I2C| library
|
|
that allows you to control an |I2C| bus via xCORE ports.
|
|
|I2C| is a two-wire hardware serial
|
|
interface, first developed by Philips. The components in the libary
|
|
are controlled via C using the XMOS multicore extensions (xC) and
|
|
can either act as |I2C| master or slave.
|
|
|
|
The libary is compatible with multiple slave devices existing on the same
|
|
bus. The |I2C| master component can be used by multiple tasks within
|
|
the xCORE device (each addressing the same or different slave devices).
|
|
|
|
The library can also be used to implement multiple |I2C| physical interfaces
|
|
on a single xCORE device simultaneously.
|
|
|
|
Features
|
|
........
|
|
|
|
* |I2C| master and |I2C| slave modes.
|
|
* Supports speed up to 400 Kb/s (|I2C| Fast-mode).
|
|
* Clock stretching support.
|
|
* Synchronous and asynchronous APIs for efficient usage of processing cores.
|
|
|
|
Software version and dependencies
|
|
.................................
|
|
|
|
The CHANGELOG contains information about the current and previous versions.
|
|
For a list of direct dependencies, look for DEPENDENT_MODULES in lib_i2c/module_build_info.
|
|
|
|
Related application notes
|
|
.........................
|
|
|
|
The following application notes use this library:
|
|
|
|
* AN00156: How to use the I2C master library
|
|
* AN00157: How to use the I2C slave library
|
|
* AN00181: xCORE-200 explorer accelerometer demo
|
|
|
|
Required Software (dependencies)
|
|
================================
|
|
|
|
* lib_xassert (www.github.com/xmos/lib_xassert)
|
|
|
|
Documentation
|
|
=============
|
|
|
|
You can find the documentation for this software in the /doc directory of the package.
|
|
|
|
Support
|
|
=======
|
|
|
|
This package is supported by XMOS Ltd. Issues can be raised against the software at: http://www.xmos.com/support
|