SmartThings Device handlerin asennus

Ajattelin kirjoittaa artikkelin, jossa ohjeistetaan SmartThings device handlerin (ts. DTH) asennukseen ja käyttöönottoon GitHub-repositorya, sekä manuaalista asennusta käyttäen. Olen huomannut, että ST-community -ketjuissa aina vähintäänkin kourallinen ihmisiä kysyy, että ”miten device handler asennetaan?”. Communityssa nätisti kysyjille kyllä useimmiten vastataan, mutta joskus pointataan lukemaan communityn wikiä. Ohjaaminen wikiin voi joskus kuulostaa tylyltä, mutta hyvin ylläpidetyssä wikissä tieto on kyllä aidosti saatavilla. Joskus kuitenkin pikaohje teksteineen on paikallaan.

Device handlerin asennus GitHubista tai manuaalisesti tehden on hyvin yksinkertainen juttu ja kirjoittelinkin pienimuotoisen ohjeen, jos joku meikäläisistä asian kanssa painii. Esimerkkinä ohjeessa käytän ”Weather Station Tile 2.0” -device handleria.

Device handlerin asennus

Aloitetaan device handlerin asennuksella loggautumalla SmartThings IDE:en, ja siirtymällä ylävalikosta ”My Device Handlers” -kohtaan. Device handler -ruudussa on nähtävissä kaikki tällä hetkellä käytössä olevat tai asennetut device handlerit.

Device handlerin luominen voi tapahtua useimmiten kahdella vaihtoehtoisella tavalla. Käyttäjä voi kopioida kehittäjän device handler -koodin manuaalisesti IDE:en, tai pykälää helpommin käyttämällä kehittäjän tarjoamaa Github-ohjelmavarastoa. Tehdään aluksi asennus käyttäen tätä viimeksi mainitsemaani ohjelmavarastoa

Asennus GitHubia käyttäen

Valitse IDE:n oikeasta yläkulmasta ”Settings”.

Settings-alavalikosta valitse ”Add new repository”.

Luo seuraavaksi uusi repository-rivi kehittäjän kertomilla tiedoilla. Tiedot löytyvät usein ST-communityn kyseistä device handleria koskevasta säikeestä, tai kehittäjän GitHub-sivuilta. Täytä jokaiset kolme kohtaa (owner, name ja branch). Esimekki-casessa kehittäjän repository owner on ”takissd”, name on ”MySmartThings” ja branch on ”master”. Klikkaa lopuksi ”Save”.

Seuraavaksi klikkaa IDE:n oikeassa ylävalikossa olevaa ”Update from Repo” -painiketta ja valitse alavalikosta se repository, jonka juuri edellisessä vaiheessa lisäsit.

Seuraavaksi eteen aukeaa repositoryn sisältö GitHubista. Mikäli kehittäjällä on GitHub-ohjelmavarastossa materiaalia jaossa, näkyy se hieman tilanteesta riippuen joissakin näkymän kolmesta sarakkeesta. Tässä esimerkissä asennetaan uutta aiemmin käyttämätöntä device handleria, joten tiedosto koodeineen löytyy oikeassa reunassa olevasta ”New (only in GitHub)” -sarakkeesta. Klikkaa täppä device handlerin eteen, klikkaa alhaalta ”Publish” ja paina lopuksi ”Execute Update”.

Onnistuneen lisäyksen jälkeen IDE:n yläreunassa tulisi näkyä vihreällä taustalla oleva tiedote.

Nyt kun device handler on onnistuneesti asennettu, voidaan siirtyä IDE:ssä ”My Devices” -kohtaan tekemään tarvittavia konfigurointimuutoksia. Näistä löytyy yleensä tarkempi ohjeistus kehittäjän ST-community säikeestä, tai GitHub-sivuilta. Ohjeistus vaihtelee aina hieman sen mukaan, mitä device handlerilla pyritään SmartThingsissa tekemään tai mihin sitä käytetään.

Tehdään seuraavaksi sama asennus, mutta manuaalitapaa käyttäen.

Asennus manuaalisesti

Aloitetaan device handlerin asennuksella loggautumalla SmartThings IDE:en, ja siirtymällä ylävalikosta ”My Device Handlers” -kohtaan. Device handler -ruudussa on nähtävissä kaikki tällä hetkellä käytössä olevat tai asennetut device handlerit.

Valitse oikeasta yläkulmasta ”Create New Device Handler”.

Valitse keskimmäinen vaihtoehto, eli ”From Code”.

Avaa seuraavaksi selaimella toinen välilehti auki ja siirry kehittäjän GitHub-sivuille. Kehittäjän GitHubista pitäisi löytyä device handler -tiedosto, joka on yleensä .groovy -tiedostopäätteinen. Avaa tiedosto selaimella auki klikkaamalla groovy-tiedostoa.

Kun tiedosto on avattu, sen sisältä löytyy device handlerista riippuen satoja tai tuhansia rivejä koodia. Maalaa koko koodisisältö hiirellä, ja kopioi se (ctrl+c).

Liitä seuraavaksi teksti IDE:ssä auki olevaan ”From Code” -tekstialueeseen. Pidä huoli, että koodin aloittavat ja lopettavat merkit ovat tismalleen samat kuin kehittäjän GitHubissa. Tässä on ajatuksena vain varmistaa, ettei yksikään merkki koodista ole jäänyt kopioimatta koska se yleensä aiheuttaa toimimattomuuden koodissa. Klikkaa lopuksi ”Create” sivun alareunasta.

Jos ja kun kaikki sujui onnistuneesti, niin sivun yläreunaan pitäisi tulla vihreällä taustalla oleva vaste, joka kertoo device handlerin lisäyksen onnistuneen.

Nyt kun device handler on manuaalisesti asennettu, voit siirtyä IDE:ssä ”My Devices” -kohtaan tekemään tarvittavia konfigurointimuutoksia. Näistä löytyy yleensä tarkempi ohjeistus kehittäjän ST-community säikeestä, tai GitHub-sivuilta. Ohjeistus vaihtelee aina hieman sen mukaan, mitä device handlerilla pyritään SmartThingsissa tekemään tai mihin sitä käytetään.

Vieritä ylös