Enjox-lelun HTTP SDK -dokumentaatio

Yleiskatsaus

Kolmannen osapuolen sovellukset voivat käyttää Enjox HTTP SDK:ta lelujen ohjaamiseen.

HTTP SDK -toiminnon tarjoaa EnjoxRemote-sovellus. Tällöin EnjoxRemote-sovellus toimii Bluetooth ↔ HTTP -välityspalvelimena, jonka avulla voit helposti ohjata kaikkia samassa puhelimessa (tai Wi-Fi-verkossa) olevia leluja standardin HTTP-protokollan kautta. Käyttäjien on käynnistettävä EnjoxRemote-sovellus ennen oman sovelluksesi käynnistämistä HTTP SDK:n käyttämiseksi.

Arkkitehtuuri: Sovelluksesi kommunikoi EnjoxRemote-sovelluksen kanssa HTTP SDK:n kautta, ja EnjoxRemote-sovellus kommunikoi Enjox-lelujen kanssa Bluetoothin kautta.

Testisivu >>

Huomio: Kun käytät Wi-Fi-verkon kautta, korvaa 127.0.0.1 sen laitteen IP-osoitteella, jolla EnjoxRemote-sovellus on käynnissä. Oletusportti on 8089.

Kutsumenetelmä

http://127.0.0.1:8089/{command}?param=value[&token=xxx]

Pyyntömenetelmä

GET, POST

Pyynnön parametrit

Vastauksen muoto

{"ret": 0, "data": 0}

Yksinkertainen API

Lelun värinä

http://127.0.0.1:8089/vibrate?speed=num&time=msec

Toiminto

Saa lelun värisemään msec millisekunnin ajan

Pyyntömenetelmä

GET

Pyynnön parametrit

Esimerkki

http://127.0.0.1:8089/vibrate?speed=20&time=1000

Rajoitus

Kahden komennon välinen vähimmäisaika on 100 ms

Lelun pyörintä

http://127.0.0.1:8089/rotate?speed=num&time=msec

Toiminto

Saa lelun pyörimään msec millisekunnin ajan

Pyyntömenetelmä

GET

Pyynnön parametrit

Esimerkki

http://127.0.0.1:8089/rotate?speed=20&time=1000

Lelun pysäytys

http://127.0.0.1:8089/stop

Toiminto

Pysäyttää kaikki lelun toiminnot

Pyyntömenetelmä

GET

Pyynnön parametrit

Ei mitään

Kuvio-API

Esiasetetut kuviot

http://127.0.0.1:8089/preset?id=num

Toiminto

Saa lelun värisemään ennalta määritetyillä kuvioilla

Pyyntömenetelmä

GET

Pyynnön parametrit

Esimerkki

http://127.0.0.1:8089/preset?id=1

Huomautukset

Lelun voi pysäyttää milloin tahansa yksinkertaisen API:n avulla. Jos sitä ei pysäytetä, lelu jatkaa kuvion toistamista loputtomiin, kunnes akku tyhjenee.

Kuviovirta

http://127.0.0.1:8089/pattern

Toiminto

Lähettää sarjan komentoja lelulle

Pyyntömenetelmä

POST

Pyynnön parametrit

Esimerkki

http://127.0.0.1:8089/pattern

Pyynnön runko

Content-Type: application/x-www-form-urlencoded

data=V:1;F:v,r;S:100;#0,0;2,0;4,3;5,5;6,6;

Huomautukset

Kuviovirtoja voi kirjoittaa itse tai tallentaa EnjoxRemote-sovelluksessa sormella liu'uttamalla.

Kuviovirran muoto

Kuviovirta koostuu kuvio-otsikosta ja kuviodatasta, jotka erotetaan #-merkillä. Kuvio-otsikon kuvaus on alla olevassa taulukossa. Kuviodata on merkkijono pilkulla erotettuja numeropareja, jotka erotetaan puolipisteillä, ja kukin pari vastaa kuvio-otsikon toimintotyyppejä (esim. kun F=v,r, kukin pari sisältää arvot värinälle ja pyörinnälle).