From c45c625872b14829cd4304e1367708d4bed520b9 Mon Sep 17 00:00:00 2001
From: Ben Hardill <b.hardill@gmail.com>
Date: Mon, 22 Dec 2014 13:12:34 +0000
Subject: [PATCH] Updated doc and added package.json

---
 hardware/sensorTag/README       |  5 -----
 hardware/sensorTag/README.md    | 26 ++++++++++++++++++++++++++
 hardware/sensorTag/package.json | 24 ++++++++++++++++++++++++
 3 files changed, 50 insertions(+), 5 deletions(-)
 delete mode 100644 hardware/sensorTag/README
 create mode 100644 hardware/sensorTag/README.md
 create mode 100644 hardware/sensorTag/package.json

diff --git a/hardware/sensorTag/README b/hardware/sensorTag/README
deleted file mode 100644
index 2d6657ab..00000000
--- a/hardware/sensorTag/README
+++ /dev/null
@@ -1,5 +0,0 @@
-This currently requires the sensortag library
-
-To install use the following command in the Node-Red directory
-
-npm install sensortag
diff --git a/hardware/sensorTag/README.md b/hardware/sensorTag/README.md
new file mode 100644
index 00000000..f443f893
--- /dev/null
+++ b/hardware/sensorTag/README.md
@@ -0,0 +1,26 @@
+node-red-node-sensortag
+=======================
+
+This node adds support to Node-RED to read from the Texas Instruments SensorTag.
+
+The SensorTag is a Bluetooth LE device hosting the following sensors:
+* Ambient & ir Temperature
+* Barometric Pressure
+* Humidity
+* 3 axis Accelerometer
+* 3 axis Magnetometer
+* 3 axis Gyroscope
+* 2 push Buttons
+
+The config node allows the user to enable/disable any of the sensors listed above. The readings from 
+these sensors will be sent as a JSON object payload with the sensor name appended to the topic provided:
+
+* Temperature - { topic: [topic_prefix]/temperature, payload: { ambient: 21.2, object: 33.0 } } 
+* Barometric Pressure - { topic: [topic_prefix]/pressure, payload: { pres: 1000.1 } }
+* Humidity - { topic: [topic_prefix]/humidity , payload: { temp: 21.2, humidity: 88} }
+* Accelerometer - { topic: [topic_prefix]/ , payload: { x:0.0, y:9.8, z:0.0 } }
+* Magnetometer - { topic: [topic_prefix]/ , payload: { x:0.0, y:0.0, z:0.0 } }
+* Gyroscope - { topic: [topic_prefix]/ , payload: { x:0.0, y:0.0, z:0.0 } }
+* Buttons - { topic: [topic_prefix]/ , payload: { left: "down", right: "up"} }
+
+**NOTE:** Node-RED needs to be run as root inorder or access the Linux Bluetooth 4.0 system calls
\ No newline at end of file
diff --git a/hardware/sensorTag/package.json b/hardware/sensorTag/package.json
new file mode 100644
index 00000000..97091be1
--- /dev/null
+++ b/hardware/sensorTag/package.json
@@ -0,0 +1,24 @@
+{
+	"name": "node-red-node-sensortag",
+	"description": "A Node-RED node to read data from a TI SensorTag",
+	"version": "0.0.1",
+	"keywords" : ["node-red","sensortag"],
+	"dependencies": {
+		"sensortag" : "0.1.9"
+	},
+	"license": "Apache",
+	"repository" : {
+        "type":"git",
+        "url":"https://github.com/node-red/node-red-nodes/tree/master/hardware/sensorTag"
+    },
+	"node-red" : {
+		"nodes" : {
+			"sensortTag": "79-sensorTag.js"
+		}
+	},
+	"autor": {
+		"name": "Ben Hardill",
+		"email":"hardillb@gmail.com",
+		"url": "http://www.hardill.me.uk/wordpress"
+	}
+}
\ No newline at end of file