From 7612de9ec766d0e61b9adaad49c2748694d578d9 Mon Sep 17 00:00:00 2001 From: Matthew Treinish Date: Thu, 21 Jun 2018 12:20:58 -0700 Subject: [PATCH] Add documentation for the new watson_iot component (#5100) * Add documentation for the new watson_iot component This commit adds documention for the new watson_iot component which was added in home-assistant/home-assistant#13664 It links to the official documentation for setting up the cloud service and generating the required auth information. * :pencil2: Missing comma * Use configuration tags This commit updates the formatting of the configuration section of the documentation. Previously it manually formatted a list instead of leveraging the templating format. This corrects that oversight and uses the standard format. * :art: Adds logo * :arrow_up: ha_release -> 0.68 * :pencil2: Processed RFC's --- source/_components/watson_iot.markdown | 104 +++++++++++++++++++++++++ source/images/supported_brands/ibm.png | Bin 0 -> 2014 bytes 2 files changed, 104 insertions(+) create mode 100644 source/_components/watson_iot.markdown create mode 100644 source/images/supported_brands/ibm.png diff --git a/source/_components/watson_iot.markdown b/source/_components/watson_iot.markdown new file mode 100644 index 00000000000..b5c30202d49 --- /dev/null +++ b/source/_components/watson_iot.markdown @@ -0,0 +1,104 @@ +--- +layout: page +title: "IBM Watson IoT Platform" +description: "Record events in the IBM Watson IoT Platform." +date: 2018-04-03 22:09 +sidebar: true +comments: false +sharing: true +footer: true +logo: ibm.png +ha_category: History +ha_release: 0.72 +--- + +The `watson_iot` component enables you to link the devices in Home Assistant +with an [IBM Watson IoT Platform instance](https://www.ibm.com/us-en/marketplace/internet-of-things-cloud). + +## {% linkable_title Configuration %} + +To use this component, you first need to register a gateway device type and then +a gateway device in your IoT platform instance. For instructions on how to do +this check the [official documentation](https://console.bluemix.net/docs/services/IoT/gateways/dashboard.html#IoT_connectGateway) +which provides the details on doing this. After you register the gateway device +for your home-assistant you'll need 4 pieces of information: + - Organization ID + - Gateway device Type + - Gateway device ID + - Authentication Token + +With this basic information you can configure the component: + +```yaml +# Example configuration.yaml entry: +watson_iot: + organization: 'organization_id' + type: 'device_type' + id: 'device_id' + token: 'auth_token' +``` + +{% configuration %} +organization: + description: The Organization ID for your Watson IoT Platform instance + required: true + type: string +type: + description: The device type for the gateway device to use + required: true + type: string +id: + description: The device id for the gateway device to use + required: true + type: string +token: + description: The authentication token for the gateway device + required: true + type: string +exclude: + description: Configure which components should be excluded from recording to Watson IoT Platform. + required: false + type: map + keys: + entities: + description: The list of entity ids to be excluded from recording to Watson IoT Platform. + required: false + type: list + domains: + description: The list of domains to be excluded from recording to Watson IoT Platform. + required: false + type: list +include: + description: Configure which components should be included in recordings to Watson IoT Platform. If set, all other entities will not be recorded to Watson IoT Platform. Values set by the **blacklist** option will prevail. + required: false + type: map + keys: + entities: + description: The list of entity ids to be included from recordings to Watson IoT Platform. + required: false + type: list + domains: + description: The list of domains to be included from recordings to Watson IoT Platform. + required: false + type: list +{% endconfiguration %} + + +## {% linkable_title Examples %} + +### {% linkable_title Full configuration %} + +```yaml +watson_iot: + + exclude: + entities: + - entity.id1 + - entity.id2 + domains: + - automation + include: + entities: + - entity.id3 + - entity.id4 +``` diff --git a/source/images/supported_brands/ibm.png b/source/images/supported_brands/ibm.png new file mode 100644 index 0000000000000000000000000000000000000000..6aee8b979344e19a0207c29109a7fb75ac27dee7 GIT binary patch literal 2014 zcmYjR3piAH8=qS)Ba=&VoiSrjwulYkqsBGkGK)-$T!yIiU}nxpB%eJ`61mj4)XIu( zn@vmBtz61nP#-qA@vR6R1V;n{1xt|x05}2^N(vHkLaU6E0*T06kpWK(NVcD7LnJ_O z0a!p}x31?xGFL$22q{1ssf&n+2ZR;~fwKtPx)z1gLW&k6q7Y){pFju!rWL4z01Pr| zaGb;yA^su6`Tutz1Lz#>M!|?rVr<(#YzVVJ1~!a)4C*9c4+8c8X1zzQz%Wh(JOB)d z4SXW%)Z^_41AE=ox*r+gPIwTU1y0s)H*ABZfF<3SmjAg0=E1-zNY_FVLN3DtHsHUN zi1Z7JfTtB4)I8pZOaLh&0oe8&?M9yRz*0nDlKQbiGQ6=MfJexYE&%7cTc85kiAR71%X8np}#k~J_HoAVq=)Hfg|G;N~Kb7Jnv`l>NFqsV;n?z{J!#Ts6OXg z-S>*Wp6>mg6tMNv=X(b+vCo+3RjvPYS#ymqD|e@j+wOY#F*;*k^DRbt>36LD+jE+# zZ;=hfQd9(qkaVL61ez4gsmjoMDPzEa?P|?z z`__LNX1(* z){hpSVkl=+oD@_&8jSM}x3DxOIQNo2M#o|AJ`i{H;7{EMt`3U1?8^w*o^;PQ3tMYm z{=#P5L&8qn&-wupxLerFFTazY3ysp@A4-dtZ`9}8DOo0rB8u5!^F}P*Us5 z+1t&Dd(7&7>gm7AV^oy|V4s@1mpE28W!}@si8C%|E>MY|7j4Hs$I=S=D{?0kSKy2A zuhx;tl4}xN%CHA*^hxa5`}*9BEAYOr9n?zU3vS97UOCf~I-z(UeF;OL#BCbcVl!9k zb~SupI_LD@>sk`Fym#nNo4$?|2Qe55a23IxR6MlXa>;0JA;Zvo!ViQ9&^&4R_ZB)sgcnO~6e=ksruuo%-b>H}R zPm_kkRtuL>s^%M~cv!qjpfrF(f%J4CA3!j!8rdCLLakA|~D3 zw7ETDy!Tu6rch^2Rl-%7ukZkO>df+)nj`LS6K2xiLSkP6{SJNb-Cn-oZuJ_BS;cl& zj_3irbP1xhcxRn&)Z)LiAgq|(o*B-^@3^~Ei+MQY=)oXs_*h@8!CcQMEIDpTUM`kP zDf2hH-h>`|6|g_6Fv&?MUu3-7KOK?8QSHl;uZVu3>@Tfl4@eF-mf-`p?`HHntW=NrPhyo@xR!gG(yQ#ARrqq0MKtoBubFm7y z&76ETQ$0q>S>W3bm!I2%PJ-K51n*IT)yJ8B!RMa*B`mY=hKP^~*MN(mF2 zM4Eh%PV9-)es9I1T>b<9)^2m^`4@B@EI))xwYY%Y=@pfg&pOmL8w+%_8r7n1a!EZ@wblp%d`hn}H z64DzvhCvZrboC}@;)KB6+w?Skg=oZVCUR##&{*ibQrZ$Vn6Prtbt_t~t;a?Aot&QD z$YD90j>LX&A<>fcVMN@H!Vp%v2JUjr#yP90VcfL~9w?!FTbbuPZcT~mn6YGBP~Qjs OwkWzQ!==iJb^5=@n1g`; literal 0 HcmV?d00001