Creates an I2C slave device on the hardware I2C bus of an Arduino compatible microcontroller.
I2C_Slave is intended for use with the Lua scripting engine on ArduPilot autopilots to allow communication with otherwise unsupported sensors. However, it can easily be used wherever a simple means of I2C communication is desired.
Install the library via the Arduino Library Manager or PlatformIO Library Registry.
Alternatively, download the zip file from releases and follow Arduino's instructions for importing a zip file. If you prefer PlatformIO, unzip or clone the library to your project’s lib/ directory.
The library's Slave object is used much like the Wire object. The library uses the hardware I2C bus and, in the background, the default Wire object, so any connected I2C peripherals should probably use a different bus, such as one created with the SoftwareWire library.
To create an I2C slave interface, call the begin() method from within your sketch's setup() function. The single byte address argument is optional and defaults to the unused address, 0x09.
void setup() {
Slave.begin(); // or Slave.begin(0x0A);
}
The library creates virtual registers in which a data object may be stored. The size (in bytes) of the data object is stored in the first byte (register 0). The remainder of the registers contain the data object as a byte (char) array. Store data using the writeRegisters() method.
float my_data = 3.14159265;
Slave.writeRegisters(my_data);
The library expects read requests to be preceded by a single byte transmission containing the requested register index. Received transmissions of exactly two bytes are interpreted as commands. Transmissions longer than two bytes will be discarded as errors.
Commands are handled by a callback function passed to the onCommand() method. A switch statement makes for a simple command handler.
int first = 1;
int second = 2;
void command_handler(uint8_t command, uint8_t value) {
switch (command) {
case 0x00:
Slave.writeRegisters(first);
break;
case 0x01:
Slave.writeRegisters(second);
break;
case 0x02:
first = value;
break;
case 0x03:
second = value;
break;
}
}
Slave.onCommand(command_handler);
This library's equivalent of blink.ino - stores the value of analogRead(A0) into the virtual registers. No command callback is defined. The ArduPilot script, extras/basic.lua simply reads the register data and provides it to the GCS as a named float value.
Demonstrates writing a character buffer to the virtual registers. The ArduPilot script, extras/hello_world.lua retrieves the characters and concatenates them into a string.
Builds upon the basic example, providing access to every analog pin's value via a set of commands interpreted by the callback function, command_handler(). The ArduPilot script, extras/analog_read.lua accompanies and shows how to unpack received signed integer values rather than assuming receipt of unsigned values.
Polls OneWire temperature sensors connected to pin 2, transmits their values upon request, and interprets a small set of configuration commands. The ArduPilot script, extras/ds18b20.lua shows how to unpack IEEE754 float values and provide them to the GCS as named floats.
For the latest developments and news on the project, join the discussion on the ArduPilot Discuss Forum. Pull requests are always welcome.
Copyright © 2024 Yuri Rage
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/.