update README
authorEugene Crosser <crosser@average.org>
Mon, 21 Dec 2015 07:30:36 +0000 (10:30 +0300)
committerEugene Crosser <crosser@average.org>
Mon, 21 Dec 2015 07:30:36 +0000 (10:30 +0300)
README.md

index 30bd784587027958e604bf1b4b2c943446c9a01e..0ed3bd61b27a396411060dc16e0d95830845c0be 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,6 +1,17 @@
-% Electric pulse counter on msp430 + cc2541 BLE module
+# Electric pulse counter on msp430 + cc2541 BLE module
 
 Counter of circuit close events on GPIO pins, using TI MSP430
 microcontroller (on the LaunchPad MSP430G2) and TI CC2541 Bluetooth
 Low Energy (Bluetooth Smart) module with Emmoco firmware, based
 on Emmoco example code.
+
+`msp430` directory contains microcontroller code for the sensor.
+Connect the wires from the water meters to the ground pin and
+pins P1.4 and P1.5 for cold and hot meters respectively. Internal
+pullup is used. To save power, modify the code to disable internal
+pullup, and use external pullup resistor of 5 - 10 MOhm. And
+probably disable VCLK in sleep mode.
+
+`linux` directory contains the code to be run on Linux host. It
+uses BlueZ infrastructure. You will need a BT 4.0 compatible
+hardware connected to the host.