From 54ca6ebc5c24d51d30d4cc6c4b7a8c1b97130160 Mon Sep 17 00:00:00 2001 From: John Mihalic Date: Tue, 2 May 2017 12:04:41 -0400 Subject: [PATCH] Eight Sleep docs (#2499) --- .../binary_sensor.eight_sleep.markdown | 18 +++++ source/_components/eight_sleep.markdown | 67 ++++++++++++++++++ .../_components/sensor.eight_sleep.markdown | 18 +++++ .../images/supported_brands/eight_sleep.png | Bin 0 -> 1795 bytes 4 files changed, 103 insertions(+) create mode 100644 source/_components/binary_sensor.eight_sleep.markdown create mode 100644 source/_components/eight_sleep.markdown create mode 100644 source/_components/sensor.eight_sleep.markdown create mode 100644 source/images/supported_brands/eight_sleep.png diff --git a/source/_components/binary_sensor.eight_sleep.markdown b/source/_components/binary_sensor.eight_sleep.markdown new file mode 100644 index 00000000000..b8dc41c9f9e --- /dev/null +++ b/source/_components/binary_sensor.eight_sleep.markdown @@ -0,0 +1,18 @@ +--- +layout: page +title: "Eight Sleep Binary Sensor" +description: "Instructions how to integrate binary motion sensors for Eight Sleep within Home Assistant." +date: 2017-04-24 00:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: eight_sleep.png +ha_category: Binary Sensor +ha_release: "0.44" +--- + + +The `eight_sleep` binary sensor platform lets you observe the presence state of a [Eight Sleep](https://eightsleep.com/) cover/mattress through Home Assistant. + +Devices will be configured automatically. Please refer to the [component](/components/eight_sleep/) configuration on how to setup. diff --git a/source/_components/eight_sleep.markdown b/source/_components/eight_sleep.markdown new file mode 100644 index 00000000000..ee8f95b789d --- /dev/null +++ b/source/_components/eight_sleep.markdown @@ -0,0 +1,67 @@ +--- +layout: page +title: "Eight Sleep" +description: "Interface an Eight Sleep smart cover or mattress to Home Assistant" +date: 2017-04-24 00:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: eight_sleep.png +ha_category: Hub +ha_release: "0.44" +--- + +The `eight_sleep` component allows Home Assistant to fetch data from your [Eight Sleep](https://eightsleep.com/) smart cover or mattress. + +It's setup utilizing 'Sensor' components to convey the current state of your bed and results of your sleep sessions and a 'Binary Sensor' component to indicate your presence in the bed. A service is also provided to set the heating level and duration of the bed. + +To get started add the following information to your `configuration.yaml` file: + +```yaml +# Example configuration.yaml entry +eight_sleep: + username: "user@email.com" + password: "password" +``` + +Configuration variables: + +- **username** (*Required*): The email address associated with your Eight Sleep account. +- **password** (*Required*): The password associated with your Eight Sleep account. +- **partner** (*Optional*): Default is False. Defines if you'd like to fetch data for both sides of the bed. + +### {% linkable_title Supported features %} + +Sensors: + +- eight_left/right_bed_state +- eight_left/right_sleep_session +- eight_left/right_previous_sleep_session + +Binary Sensors: + +- eight_left/right_bed_presence + +### {% linkable_title Service `heat_set` %} + +You can use the service eight_sleep/heat_set to adjust the target heating level and heating duration of your bed. + +| Service data attribute | Optional | Description | +| ---------------------- | -------- | ----------- | +| `entity_id` | no | Entity ID of bed state to adjust. +| `target` | no | Target heating level from 0-100. +| `duration` | no | Duration to heat at the target level in seconds. + +Script Example: + +```yaml +script: + bed_set_heat: + sequence: + - service: eight_sleep.heat_set + data: + entity_id: "sensor.eight_left_bed_state" + target: 35 + duration: 3600 +``` diff --git a/source/_components/sensor.eight_sleep.markdown b/source/_components/sensor.eight_sleep.markdown new file mode 100644 index 00000000000..42ed89e0586 --- /dev/null +++ b/source/_components/sensor.eight_sleep.markdown @@ -0,0 +1,18 @@ +--- +layout: page +title: "Eight Sleep Sensor" +description: "Instructions how to integrate sensors for Eight Sleep within Home Assistant." +date: 2017-04-24 00:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: eight_sleep.png +ha_category: Sensor +ha_release: "0.44" +--- + + +The `eight_sleep` sensor platform lets you observe states of [Eight Sleep](https://eightsleep.com/) sensors through Home Assistant. This includes bed state and results of the current and previous sleep sessions. + +Devices will be configured automatically. Please refer to the [component](/components/eight_sleep/) configuration on how to setup. diff --git a/source/images/supported_brands/eight_sleep.png b/source/images/supported_brands/eight_sleep.png new file mode 100644 index 0000000000000000000000000000000000000000..92c7d91d3ebe5172fdee2e4025f8307faba82b92 GIT binary patch literal 1795 zcmV+e2mJVnP)@6lThaA*5iFtyYeXWE_&vWUd-Cff*TO=x(2-Yo9o11F2>hkg;7KKRE0F}!2?5t-+;sSh*jA+tZ z2YJCFK4?TU{MqA)g@AnZ`Ti*>Dy*t}fv3Ezq()M8c6OG=cs&5t*r;}GZH*7Cot-Zw z#p23}^6ILJveM$0QVFaw6TzZzs8mBICnua{h|hQL-sWUK7Z>K`r*-D$K5B;5E6dBQ=!vc(>BT2R@%dC@YLbj{MPfu?&z$uiY{)E+a0#zw z9UL4u9CqS&SY5IY5|#!~IX^!m z_0bP=(9`HN@WO0(2Uc@aL-(7mB#nryM61>0=42s6B2X3<`4@s5%||M;CYyfZ_Iq-uP8OyH{GgM|<&F3g9XV%`AD>6{nX zZGD}*r>A>sYs8i+wIGDukn88rt~SC^n||?;elGeRz1dv$JC~OaU@k ztrV(3>KF|MK)?wW$_-O`vJ+e0n-MXlR4REt*pIi3jg8&ioqL)^mZ4S+0ZXRNCkz(Q z0iP%>5yKLtHPwMYK%l|`tkF>|pLGK)DBAqIBWhV!L}jv`{|48=s(*ZZ{Bd@cdQy|o z2oA^z7RpUV18aH;g^VD`9Sv_HeJBLHv?Cf=X_DdWW_~7POLJ3udmA=NxM>3{WLIz^ zmzS5JZ$e!jzykFpU=bICugEcoSEBKYslpU2>>28W?+Z#$PQW6nN(2s9H#vb9(k(A3 z#Vk{P*diSII)#k50zS>6U_rp|VC;dTBW3`J+#VT)Kn$5+L4!C)q?*NCHNg6yn~ZfG zqF5tJiBJdpC?#!aZftI9M9whueo%$KfqtECl2fxFs3e!Y6fzBq*<4yuq*A>{6Xt^w zlv~WEM8HaIvXa1wP3x;>xvaLcL)oEx-Px&Z|EmpvQD4piYoPxfG?6uPP{nzNV{vg| zX=#xi}}%DrS>!`u~WlGnIU{I^a4?g>8fUCri;V{h{A|4 z>+83a_({wV0vB*{5=;qRSO#$%!tsKGA0Ad?ifG783^>68|IEwHvRSPpIFdTyP#6Jf z&+kXvWP&Bc!3zS5>`X8i>`=CYJ$T&iWbBbN#FEgJLSDPzbUrE?YNFANlcqDlBDA}& zuNORyNri}9U0s4|vB2V_4vByjWs-eA|MUal7YTcM(iNNqkb*lXDHdaSdwYI?cs0~3 zwAvBAn5l}iCSN^!0u*eX3nFO9fDn-p0;LZJzI~S#6ip^QyiXUHW^t<2G7!e z(D9lfnqi_vh525uH<_y%GNCWq+gKHH1;XGd=YFtxQ)4~wh3A4w;;B=}0Xo<@P0rDq z-9E=;@ZdTK0>BHyVF?Pk3_67!>U-M@)X1PydOd#S1PkR;G5Uc)C%BTCJI(6q>iG4S zA3=PR*Q{Xh7`YB+49KvIZJ$q|W+A-*`(JR*JEIRw*kQL5w?JmKva$?zPJ5$$9vvNm zc1=u->-8T#EiIBdw8Gbe1FB^#LHXCO2dwG2T(157{n$C*frS*Tsi^_F0Od;FXBmwK z=m_@B7?Vsq#Su+v&(wsTlzP3Jpek{WPkE-xVYz<4ADQiAmmQ7~=Cb*Yk5~<3T^`>O zI6Fjj&QU~9v_ENiJ1dGqyUB~k