From ecaa94ff5363ec0fff47a2ea4d00409e20390755 Mon Sep 17 00:00:00 2001 From: JC Connell Date: Fri, 27 Jul 2018 18:35:27 -0400 Subject: [PATCH] Magicseaweed sensor documentation (#5598) * Magicseaweed sensor documentation * Making @frenck requested changes. Not sure I did this correctly but I followed the docs: https://www.home-assistant.io/developers/documentation/create_page/#configuration * Add Magicseaweed logo Transparent background version not available. API Documentation requests that this logo be used. * Changed logo name. * Remove incorrectly named logo. * Correct mapping error line 9 column 25 of YAML * HA Release Update & removed irrelevant config * Attempting to fix Jekyll errors * Add @MartinHjelmare requested changes. --- .../_components/sensor.magicseaweed.markdown | 95 ++++++++++++++++++ .../images/supported_brands/magicseaweed.png | Bin 0 -> 2021 bytes 2 files changed, 95 insertions(+) create mode 100644 source/_components/sensor.magicseaweed.markdown create mode 100644 source/images/supported_brands/magicseaweed.png diff --git a/source/_components/sensor.magicseaweed.markdown b/source/_components/sensor.magicseaweed.markdown new file mode 100644 index 00000000000..1396a5245d0 --- /dev/null +++ b/source/_components/sensor.magicseaweed.markdown @@ -0,0 +1,95 @@ +--- +layout: page +title: "Magicseaweed Sensor" +description: "How to integrate Magicseaweed within Home Assistant." +date: 2018-06-24 21:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: magicseaweed.png +ha_category: Sensor +featured: false +ha_release: "0.75" +ha_iot_class: "Cloud Polling" +--- + +The 'magicseaweed' platform uses the [Magicseaweed Forecast API](https://magicseaweed.com/developer/forecast-api) as a source for surf forecasting data for the surf spots of your choice. + +You need an API key which is free but requires [registration](https://magicseaweed.com/developer/sign-up). Magicseaweed is limiting users of the API to 2 spots for the free plan. + +To add Magicseaweed forecasts to your installation, add the following to your `configuration.yaml` file: + +```yaml +# Example configuration.yaml entry +sensor: + - platform: magicseaweed + api_key: YOUR_API_KEY + spot_id: 1092 + monitored_conditions: + - max_breaking_swell +``` + +{% configuration %} +api_key: + description: The API key to access the service. + required: true + type: string +name: + description: Spot nickname for the sensors. + required: false + default: MSW. + type: string +hour: + description: List of hours you would like to receive data for. + required: false + default: Defaults to current forecast. + type: list + keys: + 3AM: + description: Display forecast for 3AM. + 6AM: + description: Display forecast for 6AM. + 9AM: + description: Display forecast for 9AM. + 12PM: + description: Display forecast for 12PM. + 3PM: + description: Display forecast for 3PM. + 6PM: + description: Display forecast for 6PM. + 9PM: + description: Display forecast for 9PM. + 12AM: + description: Display forecast for 12AM. +spot_id: + description: ID of the surf spot. Details for getting spot id available at [Magicseaweed](https://magicseaweed.com/developer/forecast-api) + required: true + type: string +monitored_conditions: + description: Type of data to display. + required: true + type: list + keys: + swell_forecast: + description: List of forecast summaries as attributes with current summary as state. + min_breaking_swell: + description: The minimum wave height as the state with a detailed list of forecast attributes. + max_breaking_swell: + description: The maximum wave height as the state with a detailed list of forecast attributes. +units: + description: Specify the unit system. + required: false + default: Default to `uk` or `us` based on the temperature preference in Home Assistant. + type: string + keys: + uk: + description: Use UK units. + eu: + description: Use EU units. + us: + description: Use US units. +{% endconfiguration %} + + +Details about the API are available in the [Magicseaweed documentation](https://magicseaweed.com/developer/forecast-api). diff --git a/source/images/supported_brands/magicseaweed.png b/source/images/supported_brands/magicseaweed.png new file mode 100644 index 0000000000000000000000000000000000000000..3e54d8fa3590ff90778ce5d725a538dc6a81c76c GIT binary patch literal 2021 zcmVi z){l>md_;>>W+*u7srUEyeX%9xX4{oozPF2Jw~Eyv zz)}ZI;q4D0hjU?zc@=?tImfYpB{cl%k;JNrEwzd=GURSuY)Kr+=k@jV;o)IGU}YaT zKRrFAw%%9$x42ZjE4vl|qp<=kJ>KO!9Iy@{W}e_cpQQm^f~J(>$iULb;fXTl71G@L zQ)oledqBFUq-P7P6z1cWRIvA=w`+uB0ZSv6I99Y5a!-qC z{ZuNgjga*UE}x&DhXR(SgBH;g7`e(e@lp~hfGtlmN6un1BUGIx$ig#DvC>oGBPL>X zyQTLnF#y%OvI{KChz27JVW|cEt%ODyo#TbAcd>QO*IaVI9O2CjZu_*3`h09?_)uMe(%rGO(CncfS<`@8Z1E z0SF3D(qRl>pi^OKWvs2kw1k*6ZP_gitMJ5&^t*(uVS&|ZEJT#LN@b?6*;%i^0e8Cq z%RFf|jT1&uc1<}RalJ7Mpu-a2$`efG4UgmNt zWM>v&bx(zPf?feu27}Vyk|`W3+;AdbabW2-jR~wTBbIyl#he7!!^Pd$*q1NDbSCFK zrCvX<3VO1sJ$Q}}tYJyQv@yL}V5RezCxCJcUh@6Bdv1NGiP8TPSe!{u7iAa%SU&o- z=vj(ZB(+{b(QR#Hq>XX^Z@?P&O6Ndem0&$5aGz5QxFt{)kfqKe>b(-nEv(kF+P?%= zS8Ea(**B+v_|^r1W|!;j?*`VA!_;02;&>LUv}RFjxpKMW+ov`dw(cqK2&@c2;S~P^ zu+;yuzTFrRSiY24qLO@)NK$$I+1*KRIb36XZYkZD1Qz*4ve#VZq`lTeR4E|(%GrZa zSxxHT8gi|~N9x&|p<4+SOo{KP2Ii$woqg{#9I#gW@vep9aqfST z)zXbMpeg3HReJ~eSmxs;Asp&C>Q9ZtDL_;*DlU>y#%T&s=d?QMMcs(bbG7fV7OI;5 z*6yk#9}aP;2~QNx=vQA;=3qP#TFsnCSYlV61XyefZxsFJ5~@ixYE^+ejRGt(6rQ$J z%#-FI=3Mw2Uc62-&-;I~k`!7a=zXTv*74U%32+|{ECztrx5TK${66Oo|#~?i}dybR*CZ>AR&OA z#0`|S5ujm+790rk<7^|RV!8v{f}t~E9szcU4}@vXUQ77o=0ht`qX#))BHv>HOK(Rv za9^GgbG8I`z3tVqwTR`zN*9FWl)q;J_Qw#?A zQ;Co{6~M$`gWj!~Q=?xatN_dVThp^$lPJkLqJ#K=5*|@E_~%8N zYLJ~|{kkO&Qhn5h>wr=I2I@>jN{FgtW@j~+A}*Muow?6Nbz{k2lfi=FF$X|hoQ1d z-HNa2<1n^fOsGV!*iXlcLS5lm+E;NfnNb<3Y)fl6@Z>U|%z!86#T#M%O&Tkcu^g#N z&nb^HcJnhI#s`+{u=zVl%O_{I0;V?X&PMdu94WPeJW6&0T97PIP7HdBFHG3{XUzcypkFQXQ^fbdmf#uIU{LzSh z9n|(0CZ3_BjEFrqcjgNgN2