From a141accb6fc604308e7de7f7d238b67e39b9b8d5 Mon Sep 17 00:00:00 2001 From: Aaron Bach Date: Thu, 2 Aug 2018 10:41:32 -0600 Subject: [PATCH] Adds docs for OpenUV (#5940) * Adds docs for OpenUV * Member-requested changes --- .../_components/binary_sensor.openuv.markdown | 23 ++++ source/_components/openuv.markdown | 126 ++++++++++++++++++ source/_components/sensor.openuv.markdown | 23 ++++ source/images/supported_brands/openuv.jpg | Bin 0 -> 3542 bytes 4 files changed, 172 insertions(+) create mode 100644 source/_components/binary_sensor.openuv.markdown create mode 100644 source/_components/openuv.markdown create mode 100644 source/_components/sensor.openuv.markdown create mode 100644 source/images/supported_brands/openuv.jpg diff --git a/source/_components/binary_sensor.openuv.markdown b/source/_components/binary_sensor.openuv.markdown new file mode 100644 index 00000000000..21cd0cb2bc0 --- /dev/null +++ b/source/_components/binary_sensor.openuv.markdown @@ -0,0 +1,23 @@ +--- +layout: page +title: "OpenUV Binary Sensor" +description: "Instructions on how to integrate OpenUV binary sensors within Home Assistant." +date: 2018-07-31 22:01 +sidebar: true +comments: false +sharing: true +footer: true +logo: openuv.jpg +ha_category: Binary Sensor +ha_release: 0.76 +ha_iot_class: "Cloud Polling" +--- + +The `openuv` binary sensor platform allows you to view binary sensor data from +[OpenUV](http://openuv.io). + +

+You must have the [OpenUV component](/components/openuv/) configured to use +this platform. After configuring that component, binary sensors will +automatically appear. +

diff --git a/source/_components/openuv.markdown b/source/_components/openuv.markdown new file mode 100644 index 00000000000..e157ee396dc --- /dev/null +++ b/source/_components/openuv.markdown @@ -0,0 +1,126 @@ +--- +layout: page +title: "OpenUV" +description: "Instructions on how to integrate OpenUV within Home Assistant." +date: 2018-07-31 22:01 +sidebar: true +comments: false +sharing: true +footer: true +logo: openuv.jpg +ha_category: Hub +ha_release: 0.76 +ha_iot_class: "Cloud Polling" +--- + +The `openuv` component displays UV and Ozone data from +[openuv.io](http://openuv.io). + +## {% linkable_title Generating an API Key %} + +To generate an API key, [simply log in to the OpenUV website](https://www.openuv.io/auth/google). + +

+The "Limited" plan (which is what new users are given by default) is limited to +500 API requests per day. In order to leave a buffer, the `openuv` component +queries the API every 30 minutes by default. This value can be modifed (via the +`scan_interval` key), but please note that over-running the API will require +you to upgrade to a paid plan (and may disable your access in the meantime). +

+ +## {% linkable_title Base Configuration %} + +To retrieve data from OpenUV, add the following to your `configuration.yaml` +file: + +```yaml +openuv: + api_key: YOUR_OPENUV_API_KEY +``` + +To configure additional functionality, add configuration options beneath +a `binary_sensor` and/or `sensor` key within the `openuv` section of +`configuration.yaml` as below: + +```yaml +openuv: + api_key: YOUR_OPENUV_API_KEY + binary_sensors: + # binary sensor configuration options... + sensors: + # sensor configuration options... +``` + +{% configuration %} +api_key: + description: your OpenUV API key + required: true + type: string +scan_interval: + description: the frequency (in seconds) between data updates + required: false + type: int + default: 1800 +binary_sensors: + description: binary sensor-related configuration options + required: false + type: map + keys: + monitored_conditions: + description: the conditions to create sensors from + required: false + type: list + default: all (`uv_protection_window`) +sensors: + description: sensor-related configuration options + required: false + type: map + keys: + monitored_conditions: + description: the conditions to create sensors from + required: false + type: list + default: all ( `current_ozone_index`, `current_uv_index`, `max_uv_index`, `safe_exposure_time_type_1`, `safe_exposure_time_type_2`, `safe_exposure_time_type_3`, `safe_exposure_time_type_4`, `safe_exposure_time_type_5`, `safe_exposure_time_type_6` ) +{% endconfiguration %} + +## {% linkable_title Binary Sensor Types %} + +### {% linkable_title `uv_protection_window` %} + +This sensor displays `true` if UV protection (sunscreen, etc.) is recommended +at the current date and time; displays `false` otherwise. + +## {% linkable_title Sensor Types %} + +### {% linkable_title `current_ozone_level` %} + +This sensor displays the current ozone level in du (Dobson Units). + +### {% linkable_title `current_uv_index` %} + +This sensor displays the current UV index. + +### {% linkable_title `max_uv_index` %} + +This sensor displays the maximum UV index that will be encountered that day (at +solar noon). + +### {% linkable_title `safe_exposure_time_type_X` %} + +These sensors display the approximate number of minutes a particular skin type +can be exposed to the sun before burning/tanning starts. Each sensor depicts +a skin type based on the +[Fitzpatrick scale](https://en.wikipedia.org/wiki/Fitzpatrick_scale): + +* Skin Type I +* Skin Type II +* Skin Type III +* Skin Type IV +* Skin Type V +* Skin Type VI + +

+The above guidelines constitude estimates and are intended to help informed +decision making. They should not replace analysis, advice, or diagnosis from a +trained medical professional. +

diff --git a/source/_components/sensor.openuv.markdown b/source/_components/sensor.openuv.markdown new file mode 100644 index 00000000000..f777be94262 --- /dev/null +++ b/source/_components/sensor.openuv.markdown @@ -0,0 +1,23 @@ +--- +layout: page +title: "OpenUV Sensor" +description: "Instructions on how to integrate OpenUV sensors within Home Assistant." +date: 2018-07-31 22:01 +sidebar: true +comments: false +sharing: true +footer: true +logo: openuv.jpg +ha_category: Sensor +ha_release: 0.76 +ha_iot_class: "Cloud Polling" +--- + +The `openuv` sensor platform allows you to view sensor data from +[OpenUV](http://openuv.io). + +

+You must have the [OpenUV component](/components/openuv/) configured to use +this platform. After configuring that component, sensors will automatically +appear. +

diff --git a/source/images/supported_brands/openuv.jpg b/source/images/supported_brands/openuv.jpg new file mode 100644 index 0000000000000000000000000000000000000000..a15741c381c189ec382c4b97cc4a5459b9341f62 GIT binary patch literal 3542 zcmb7Gc{mj87N6C=jb#RdXb`gRV`r?{_r0=|!dQnW--pSP%35R{WM7hXVvr>zTkX7(l^ov0D(Y&A;kfw(*O*B zg`RR`SWEjW?p`;% zG)x1-13bfAu6cQ!B>}=%Svfg4rMS7JJam+GJpOMx?F7JR02zP`Fc1a+!GK^G@U#bj z1OR|gO0oZCKoA%LrJ|;QIxGMn7z74W(@;}U|Be6xC?E_fAj7I{$;N)(+AT0hR^BE$ zwXkl4ibKvl?a@=X4hFxljS>`6(6#EK7Y)h01RLXHw+8|XaaU2fG8FaK#K+l;Q!yFE~o$ku^N2q z9M0?a?jm}UQ@k(Zp$h?~Z(_2BlwGusyFGpi5ZN^_-|`fGS+KgTuI>IK^gw<_3;oN$ z@lYp8a!zwWH8YGU(sJz2lw8-@$gY<7sFhJ(uQl4&A6Jf%|3J3Cp=k6E?UM`5B8$&< zl%%(L_KK>1LMUgm&wOA4IfO8uYx`3FGaqE7iPvopvWPtkl2R}KqTZ!k6_MH!AMJd_ zLgA02POGNS=aWqL;BGzHrX_yEH!fHHsMyKwdffPR_p(p+Uc5Y>X}i6zLcD13gE>P` z%6Xs#$9g5w96mCb8?{(R8np=;7^hac%WdR(ae&}=X~`@oXFvsZ|9&@jxx-nX5ZX~B zz;9=OzW>|V{vwm|jvYeiNA$MJj%Dkc6n-f>%u}dlc)B-Ai|do_n5xP2Yn3yo96W52 z1o!!A2R7MZC&t%!={y?Fr8SLbPDnQk0Zg_0^aU5N;z>Kz@5`vn$RxI2FlxB}7He5yZs{bisj~;Px*>myE-iyzr%ckn z&?>`fDrE(^>3OO6irgK3qV)aIZ#%aB@Y-93x5rD=ioAuIAog~OQWjHmM(cS;1<}8b z*h6mesh$Ev%Te$&qPNk39dfRp+Ca*tpt$ySnT;2325#4O+peKtp4aaYQ(?FeHC3>0 zrR__Pe8XO3?FIpvj+Q}kuWJi3CzQNviU$=IIZWhqaf;E;OWuXv2YXMnjve~ja=CPT zzkaxx+l@ZyHmBVebDTJ#$F%T#90z>C18KFqL6EC?fEGK0gtlNY+n{=B4aBCtexhx5 znnI~XL_a;-1Q>;b?58Z>e45MD-7Xz2`=LFnIcoqj;rROFP;K+gt~Irp!v>9`i#847 zgiDdCE^VB~U zs3!jXmVsPIrz#K!YD6^4`zz{V!W^YW+YF3Q&GJ!=_`x*vi-GGca;(`km%MO{)9qz? zn|aHJV;gGJmw0v3o+sDz9=hOTUDVv=AFCDaC{rGc zhGDt%T9xYvQs!>XyZlj;&rhAEi=0lLc+1ea2+Kj~bsw#+7cH;o8XeNq|V{DR$IL?WI&RN>ilN!Yw(i^xjXqT!%hA4dJ|Rsmdu z`CuZ#7^_*ucCnRfL~@}YmA@glosTccOP+63O&yfVR~5iPvqkpu`(cl8U+we}#`K=o zWu#$5SXJV1(C!FNdr@*t1I%K_^SR{!M{+O^Pd6qm24z$&>u~|`_@=fqhq11$7PVjK z*VVRA%OeA4)0&lpplhT{qB+)~6TQAO^`!}BE+pQIk`LlFN}8q17xH#C)2@)l>Q^P? z1BWurtwr?=co}>#v_+-QmP=EJppRu(Ue}24wl8G7r41^d=`J%!mfE2bRjy~>mU;W( zVU4WhxqXhxLW7+rida|WJ64|uW7pI{1**Pc<#r3--Wp002adXzof#7vgMH(Avc*hc zc=uPOMJ=AgdO=eybL6%Xbw6s+m>AM*4B28%In~^#@na+^ln>A!^7? z>yBtMx{*JtDvk)`xy}H)gdesBGkc{cDEy0koP)1EH)rP3EnrsrcqK8{+Mos&aR0%& zlM@1c3MjE*wX4rb3&v!-1}t6Gu75Ycj&2w)Aq<2|BX@5%m^Mek4#bowFKmqZ zJ5n!d3N98dBnbnL6r9Jj_mle!5X=mL(((ZjvM-qOUVn`pQNu+AcDQkg`w`)it|r)e zHWyO1ZR(qSqm;Of)h+t|hXqp+4~aRI4O339jt|eVPMfdy^q&Gu^Tf7z@G8klPdfh@ zBe9neoA)fZ+1Z{n_ALG77k|&rAZ^uc8Nr^3r>uGE*B0kjUmmI6n`y_nJSBR1DSKrL zhhUYl2X=(6tjlG-tn1ddE*#30Ws(PZ-MM9fVSWu*LMF!Tss&sy`6f|Mn~_z(Ld(OR z%vCmVb5(k}tzz|dWgOfv=V_6W#KLSObAnIV4|k8q(sx<6%(Qt8at7u#p~kA`x^CP; zJt7@^Z$?;1s~~oQWsaHt=vV!b*p}>j>Nuj2zzh61;8GPR-;^kURpr?4MV*j19v3~XA<*nQr7;8Di2YurdD zFPZ7aet-D2P%fVgar{XFrm!aD#Z^*>nBL2}1A&*zr{FwKh zFw(!Jnw-x!KGQcMG*aBH_*~?;-MHd49AR;V)rg$VNO;XoVrI1QB~pt3anLr=*06`D z=#E+`{jBTc@E=kfa+R*H9*TiedjvlJsF$6*ywqI7xIIx<)S|oh#pGE?LapnW6znCT zx%ZID$XLrqQ$L(qT9$TYcm8asxRKBLOYTlG0o_MCA{t?q8 zpc8#!Hm&-7EB`{q5^{@atSwn}V-P#L@~NF;%{TuGHDSm$z%>ZR&KY52y1HAe(zZ^* zjc`AaER+1Q?6dNo^grdu3Ad%kuhq<07s>kzd?W-5g2^cPvW} z=YrWSteE%TA5O4ud0*MNH|KN;So;+(TfFNKDK0uQzIjF0f8(cS?PnXp1LozJvkOe5 zSIfU6ggNHn6#Z!RC<0vf}$SCl1 F@?R5DJ!Sv^ literal 0 HcmV?d00001