Skip to content

Commit aa8b5e3

Browse files
committed
added a warning to the I2Ccommander readme file
1 parent 4146a7b commit aa8b5e3

File tree

2 files changed

+4
-1
lines changed

2 files changed

+4
-1
lines changed

src/comms/i2c/I2CCommanderRegisters.h

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
21
#ifndef __I2CCOMMANDERREGISTERS_H__
32
#define __I2CCOMMANDERREGISTERS_H__
43

src/comms/i2c/README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,10 @@ This code takes the point of view that the motor driver (the "muscle") is the I2
99

1010
This is new code, and has not been extensively tested. Your milage may vary. That said, basic use cases have been tested, and we would certainly appreciate feedback and help with testing it out.
1111

12+
In particular, there are concurrency issues with reading/writing the SimpleFOC motor values from I2C while the motor is running. These should be solved soon in an upcoming version.
13+
14+
**Do not run on 8-bit MCUs!** The code currently assumes atomic 32 bit reads, so running on Arduino UNO or Nano is unfortunately a no-go.
15+
1216
## Using
1317

1418
As would be expected for I2C, each target device needs a unique I2C address on its bus, and setting up and discovering these addresses is out-of-scope for I2CCommander. Setting up and configuring the TwoWire objects (which pins, speed, etc...) is also out of scope and finished, initialized TwoWire objects must be passed to I2CCommander. If you don't specify a different reference, the standard *Wire* object is assumed.

0 commit comments

Comments
 (0)