From 4ba577a2f46094cbc77d4b93a4aeb6cd80f1766b Mon Sep 17 00:00:00 2001 From: citruz Date: Wed, 5 Apr 2017 07:16:41 +0200 Subject: [PATCH] Added documentation and logo for eddystone_temperature platform. (#2334) * Added documentation and logo for eddystone_temperature platform. * Update sensor.eddystone_temperature.markdown Fixed formatting and removed unnecessary shortenings. --- .../sensor.eddystone_temperature.markdown | 57 ++++++++++++++++++ source/images/supported_brands/eddystone.png | Bin 0 -> 3610 bytes 2 files changed, 57 insertions(+) create mode 100644 source/_components/sensor.eddystone_temperature.markdown create mode 100644 source/images/supported_brands/eddystone.png diff --git a/source/_components/sensor.eddystone_temperature.markdown b/source/_components/sensor.eddystone_temperature.markdown new file mode 100644 index 00000000000..b11cbd00766 --- /dev/null +++ b/source/_components/sensor.eddystone_temperature.markdown @@ -0,0 +1,57 @@ +--- +layout: page +title: "Eddystone Beacon" +description: "Instructions on how to integrate Eddystone beacons with Home Assistant in order to receive temperature data." +date: 2017-03-26 01:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: eddystone.png +ha_category: DIY +ha_release: 0.42 +ha_iot_class: "Local Polling" +--- + +The `eddystone_temperature` sensor platform reads temperature information from Bluetooth LE advertisements transmitted by [Eddystone](https://en.wikipedia.org/wiki/Eddystone_(Google)) beacons. Your beacons must be configured to transmit UID frames (for identification) and TLM frames (for temperature). +All beacons that support the Eddystone protocol, have a temperature sensor and can transmit TLM frames are compatible with this platform. For example [Gimbal](https://store.gimbal.com/collections/beacons/), [Estimote](http://estimote.com/) or [kontakt.io](https://kontakt.io/). For more manufacturers see [this overview](https://developers.google.com/beacons/eddystone#beacon_manufacturers) by Google. + +## Requirements + +As this platform uses `bluez` to scan for Bluetooth LE devices **a Linux OS with bluez installed** is required. In addition to that, the `libbluetooth` headers need to be installed: +```shell +$ sudo apt-get install libbluetooth-dev +``` + +Scanning for Bluetooth LE devices also requires special permissions. To grant these to the python executable execute the following: +```shell +$ sudo apt-get install libcap2-bin +$ sudo setcap 'cap_net_raw,cap_net_admin+eip' $(readlink -f $(which python3)) +``` + +## Configuration + +To use your Eddystone beacon in your installation, add the following to your `configuration.yaml` file: + +```yaml +# Example configuration.yaml entry +sensor: + - platform: eddystone_temperature + bt_device_id: 0 # optional + beacons: + living_room: + namespace: "112233445566778899AA" + instance: "000000000001" + name: "Living Room" # optional + kitchen: + namespace: "112233445566778899AA" + instance: "000000000002" + name: "Kitchen" # optional +``` +Configuration variables: +- **bt_device_id** (*Optional*): The id of the bluetooth device that should be used for scanning (hci*X*). You can find the correct one using `hcitool dev` (default: 0). +- **beacons** array (*Required*): The beacons that should be monitored. + - **[entry]** (*Required*): Name of the beacon. + - **namespace** (*Required*): Namespace ID of the beacon in hexadecimal notation. Must be exactly 20 characters (10 bytes) long. + - **namespace** (*Required*): Instance ID of the beacon in hexadecimal notation. Must be exactly 12 characters (6 bytes) long. + - **name** (*Optional*): Friendly name of the beacon. diff --git a/source/images/supported_brands/eddystone.png b/source/images/supported_brands/eddystone.png new file mode 100644 index 0000000000000000000000000000000000000000..77798ee4f9af5449647e281041c99bb85a466845 GIT binary patch literal 3610 zcmd57Y9+OL^E4d+(}Xrm)y#wOw$a=B@#pnL!B%vx0%6Q3rq#u%#9XJbAk#X zqs%hYyt(A0rt=w?HRhN#HQm&(#w8o=dz1rz-Oda`Oyq@(9{a zVxe$Vv6Wvywp3_Gz8+X>>PO{!%K*Zx~gk`i$YkcBI$_iplLXPZa!`%~3 zsUI`ksQRUz%f< z{bn_d++k|0Wr>(Y9iwKGD7_G^uK=omHjMsr?^~Tk1vLjT;8g(a;|GrJA8jQUZI2wv zb0z(GU`KClh}JQ!#nPFSGF=qabAHLDTyJ|;8$?TTLe~=<8MtFu@iLVFTN@=o(Qc%47yQ>;Vjy#en5pKxl1#v)c7ftPVx_fJI$0bqPo<-Xoa`EO!wjizT|55 zcAvpHpGkT6N)$Disg=|T=O(m(e9|h~GMP!tLNk2n>U<0cE7zF0u$!gl6B2HeT~&S}hCST_!)-mA*by;i z%2|P0XLUaW7ZnN5RYtMGZeis|nfPeSkEeUrzt{_-!mboR?*jVaiHuEtI%$KRiO?ew#WbKtP<;nl6wXm*?a>e0oV{V#guoZ)q|42v8Tmg`w=@jNwwK_i{ zC0=6j_qMJ(;1J&~U=^tR7pz^hR*(mq4f%;$96bqg0ocPg^+ zQX}p!9;@XIz3m_RHNHS7%PlC+?18%X&{>=O-G(G1)EsqB!=f6B;Q!8h@?mj;yt#D# zLrS6#4#xc%iw-txy@n=qqogq`9=IDVV9{XV;~PJPYYM)3knq_ zZW7h!$~q^RF6}h!SWQzi0ClG>NG4%W^!H+zXOC<}ZVqXc(0bMR^Yey(2v8FtEg-vj5Weo^h4D|zOk zSp#qe#ft;yniutl^RDq}_Hy@~$%W;n7g}(34K~w`k~M9>0SUfnuB%7Ce9fYH*4U61o+`?dBa(CA}4tVDz)~|?Ufbx1U z6B@nCUfBCA)zvRIFdcX@|L>0$NJFvajlawn$qp(Z5V?ht0n;%f0f}MSjyx z>Ug?Udd_2oUs$fSCTlb?_L^id!z7(B?Ppi$IW{u-rfJ=|L&MWQse<j_%zJ^nN-*`BqR0)g&RH6w@(oeq&X4D*7#Ew)RN&Cazc-p z!g3CknmpR^C5}x_XpbLzRq^h8>;d`)g^hb+ReF=!Wb{PjVo)C-rORZcD$VUU6qUBy z1BDR^KC-sy9rzh760gGwH{Pz+sS{tFD&-TTOCyl|$gJzBj3hR>_Nkc$HL5e1UZs{d zQ|zRU>R$Mqn*oCjL_u744at>Zv>h0GQoBsnC45egyC2IYUksd3=kGF8QZEkj8aHZE zN59@tAYBwT!5?sABalv%*B)0uB-}ZP%{lb9NAh@^6OQl^NDRo z$Uk-T!fs2cHLsl&HY{DA;NhgwL?)k4n10UNv~Xxas{6FtE12MZH4|=2Cfa=Wb^c(L zvBH<^lYP?|EmAqrxiQ5%Wx7{ZaTO);E>`Gq+g}@%&XiOPiL)LxN*T48ihql5{TfXu zn~zzpS(UO`=h(-Sn^VYfzb|b@>h(E`3rDNX^C4+8ON%a{Q z&qs1|`2=pLn(Z4rymsiqe~JJ_UCp>A{PC~1cLcj{_SxLDK?j)py#X(O`_v+20ZWp4 zuMz&9IP>(@C3+`RqKvWCnEvv3>4k-((QV5Ey4!i_tDot1j8hJ!{N*T#XnFIu=NNr& zlz>l=(7|<1ZGNNr_-4t`O*Ai=Oc#>^J+MYmDREmX7cXfgwZUynP>P(rer`j{NBa^E zgFHQ8b+qtX9u#NbjxuRkXeenET-G}~O+>0QwMvZ-!{}-}oBTwE9%mTEzronLCtIeN zVa8ou72H$Yfwr z$7%MyJEhT0ynSq@dz-l^yjq75&nTdyKyoay_;H)+6Uuyb#LpcRhKy*v!)Luo9FKEx z+!}YZ$gL$2!dId1K7vZF*6XCNX~eV!-AFAU1Si>Q+;*{?SW5;}3o2qE%^e zTft0c#PuDPnsfJfdO&Z{2Kfm#TY7T_aR6v7dqu37 zKj;Jo;Zy4TUmDwKf5;~zJ=spDyh+oKE#!`?oPxNs4&*2-^Z~n&$xgYt0WwIj7DBx0GcXj58_zR$iUF~f6RFF4Vim5U6W`7 QexSfZ4h#vX^JnM&7g1(``2YX_ literal 0 HcmV?d00001