From bdd06ce525ef909b133a6e4baf6f53b5123e7557 Mon Sep 17 00:00:00 2001 From: morgan Date: Sun, 3 Jul 2016 13:23:03 -0700 Subject: [PATCH] updated readme --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index 11ae15b..8750ee1 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,13 @@ # HamShield +Please note that I2C communications are not officially supported. + +The RF transciever on the HamShield has trouble driving large I2C bus capacitances (over 40pF). What this means is that it works well if the transciever is on the same physical PCB as the microcontroller (assuming good layout), but works poorly as a daughterboard. + +We recommend that you use the master branch, which uses a custom communications protocol. That custom protocol does not have the same bus capacitance limitation. You're welcome to play around with I2C if you want, but it may cause instability issues. + +## Hardware Changes Necessary + The i2c-comms branch is not intended for use with a stock HamShield. To use i2c communications with a HamShield 09 or above, you must first make several hardware changes to the board. @@ -12,6 +20,8 @@ Then make sure that you pull the nCS pin correctly. Changing nCS changes the I2C - nCS is logic high: A1846S_DEV_ADDR_SENHIGH 0b0101110 - nCS is logic low: A1846S_DEV_ADDR_SENLOW 0b1110001 + + HamShield Arduino Library and Example Sketches This repository is meant to be checked out into your Arduino application's libraries folder. After reloading the application, the library and example sketches should be available for use.