diff --git a/source/_components/sensor.dweet.markdown b/source/_components/sensor.dweet.markdown new file mode 100644 index 00000000000..102d7e9b427 --- /dev/null +++ b/source/_components/sensor.dweet.markdown @@ -0,0 +1,65 @@ +--- +layout: component +title: "Dweet.io sensor" +description: "Instructions how to integrate Dweet.io sensors within Home Assistant." +date: 2015-12-10 10:15 +sidebar: true +comments: false +sharing: true +footer: true +logo: dweet.png +ha_category: Sensor +--- + +The `dweet` sensor platform allows you to get details from your devices which are publishing their values to [Dweet.io](https://dweet.io/). + +To use Dweet.io in your installation, add the following to your `configuration.yaml` file: + +```yaml +# Example configuration.yaml entry +sensor: + platform: dweet + name: Dweet.io Temperature + device: THING_NAME + value_template: '{{ value_json.VARIABLE }}' + unit_of_measurement: "°C" +``` + +Configuration variables: + +- **device** (*Required*): Identification of the device (also known as `thing`). +- **name** (*Optional*): Let you overwrite the the name of the device in the frontend. +- **value_template** (*Required*): The variable to extract a value from the content. +- **unit_of_measurement** (*Optional*): Defines the unit of measurement of the sensor, if any. + +## {% linkable_title Interacting with Dweet.io %} + +You can easily send dweets from the commandline to test your sensor. + +```bash +$ curl -H 'Content-Type: application/json' -d '{"temperature": 40, "humidity": 65}' https://dweet.io/dweet/for/ha-sensor +``` +will give you a response like the one below: + +```json +{"this":"succeeded","by":"dweeting","the":"dweet","with":{"thing":"ha-sensor","created":"2015-12-10T09:43:31.133Z","content":{"temperature":40,"humidity":65}}} +``` + +The [dweepy](https://github.com/paddycarey/dweepy) module gives you another option to work with [Dweet.io](https://dweet.io/). + +Send a dweet. + +```bash +$ python3 +>>> import dweepy +>>> dweepy.dweet_for('ha-sensor', {'temperature': '23', 'humiditiy':'81'}) +{'thing': 'ha-sensor', 'created': '2015-12-10T09:46:08.559Z', 'content': {'humiditiy': 81, 'temperature': 23}} +``` + +Recieve the latest dweet. + +```bash +>>> dweepy.get_latest_dweet_for('ha-sensor') +[{'thing': 'ha-sensor'', 'created': '2015-12-10T09:43:31.133Z', 'content': {'humidity': 65, 'temperature': 40}}] +``` +