added HASS to readme

Author: LiamSnow

HASS.md

@@ -0,0 +1,104 @@
+# Home Assistant opensleep Setup
+
+## configuration.yaml
+
+```yaml
+...
+mqtt:
+  - text:
+      name: "opensleep sleep time"
+      command_topic: "opensleep/actions/set_profile"
+      command_template: >
+        {% if value %}
+            both.sleep={{ value }}
+        {% endif %}
+      retain: false
+      pattern: ^([01][0-9]|2[0-3]):[0-5][0-9](?::[0-5][0-9])?$
+      state_topic: "opensleep/state/config/profile/left/sleep"
+  - text:
+      name: "opensleep wake time"
+      command_topic: "opensleep/actions/set_profile"
+      command_template: >
+        {% if value %}
+            both.wake={{ value }}
+        {% endif %}
+      retain: false
+      pattern: ^([01][0-9]|2[0-3]):[0-5][0-9](?::[0-5][0-9])?$
+      state_topic: "opensleep/state/config/profile/left/wake"
+  - text:
+      name: "opensleep alarm"
+      command_topic: "opensleep/actions/set_profile"
+      command_template: >
+        {% if value %}
+            both.alarm={{ value }}
+        {% endif %}
+      retain: false
+      state_topic: "opensleep/state/config/profile/left/alarm"
+  - text:
+      name: "opensleep target temp"
+      command_topic: "opensleep/state/frozen/left_target_temp" # RO
+      retain: false
+      state_topic: "opensleep/state/frozen/left_target_temp"
+  - text:
+      name: "opensleep current temp"
+      command_topic: "opensleep/state/frozen/left_temp" # RO
+      retain: false
+      state_topic: "opensleep/state/frozen/left_temp"
+  - switch:
+      name: "opensleep away mode"
+      command_topic: "opensleep/set_away_mode"
+      state_topic: "opensleep/state/config/away_mode"
+      retain: false
+  - text:
+      name: "opensleep temperatures"
+      command_topic: "opensleep/actions/set_profile"
+      command_template: >
+        {% if value %}
+            both.temperatures={{ value }}
+        {% endif %}
+      retain: false
+      state_topic: "opensleep/state/config/profile/left/temperatures"
+```
+
+## Dashboard
+
+```yaml
+views:
+  - title: # ...
+    # ...
+    cards:
+      - type: entities
+         entities:
+           - entity: text.opensleep_sleep_time
+             name: sleep time
+             icon: mdi:bed-clock
+           - entity: text.opensleep_wake_time
+             icon: mdi:sun-clock
+             name: wake time
+           - entity: text.opensleep_temperatures
+             name: temperatures
+             icon: mdi:thermometer
+           - entity: text.opensleep_alarm
+             icon: mdi:alarm
+             name: alarm
+```
+
+## Automations
+
+```yaml
+alias: "opensleep leave bed"
+description: ""
+triggers:
+  - trigger: mqtt
+    topic: opensleep/state/presence/any
+    payload: "false"
+conditions: []
+actions:
+  - action: light.turn_on
+    metadata: {}
+    data:
+      brightness_pct: 100
+    target:
+      area_id: 107d
+mode: single
+```

MQTT.md

@@ -93,8 +93,8 @@
  - `Four`: 0mA\~40mA, Imax=40mA
 
 `AlarmConfig` may be "disabled" or a comma-separated list of config, where `PATTERN,INTENSITY,DURATION,OFFSET`. For example:
- - `Double,80,600,0`
- - `Single,20,600,0`
+ - `double,80,600,0`
+ - `single,20,600,0`
 
 `centidegrees_celcius` a u16 representing a temperature in centidegrees celcius IE `deg C * 100`
 

README.md

@@ -70,7 +70,7 @@ Completely replaces Frank, DAC, and Capybara - communicating directly with Senso
 
 ### Diagrams
 
-![Diagram](diagrams/main.svg)
+![Diagram](images/main.svg)
 
 ## Setup
 Before being able to setup and programs to run on Pod's SOM, you are going to need SSH access.
@@ -82,6 +82,12 @@ See [SETUP.md](SETUP.md)
 ## MQTT Spec
 Please see [MQTT.md](MQTT.md)
 
+## UI
+opensleep does not currently have a UI, however, you can easily build one in Home Assistant using MQTT. See [HASS.md](HASS.md)
+
+![Home Assistant Dashboard](images/hass.png)
+
+
 ## Roadmap
  - [ ] Use Sensor's bed temperature readings to improve Frozen
  - [ ] Sleep Tracking: Heartrate, HRV, Breathing Rate