Dokumentasjon for Enjox Toy HTTP SDK
Oversikt
Tredjepartsapper kan bruke Enjox HTTP SDK for å få styringsmuligheter over leketøyene.
HTTP SDK-funksjonaliteten leveres av EnjoxRemote-appen. I dette tilfellet fungerer EnjoxRemote-appen som en Bluetooth ↔ HTTP-proxy, slik at du enkelt kan styre alle leketøy på samme telefon (eller Wi-Fi-nettverk) gjennom standard HTTP-protokoll. Brukere må først starte EnjoxRemote-appen før de starter appen din for å bruke HTTP SDK-en.

Arkitektur: Appen din kommuniserer med EnjoxRemote-appen via HTTP SDK, og EnjoxRemote-appen kommuniserer med Enjox-leketøy via Bluetooth.
Merk: Når du kobler til via Wi-Fi-nettverk, erstatt 127.0.0.1 med IP-adressen til enheten som kjører EnjoxRemote-appen. Standardporten er 8089.
Kallemetode
http://127.0.0.1:8089/{command}?param=value[&token=xxx]
Forespørselsmetode
GET, POST
Forespørselsparametere
| Parameter | Beskrivelse | Verdier |
|---|---|---|
| command | Kommando | vibrate, rotate, preset, pattern |
| param | Parametere | Varierer avhengig av kommandoen |
| token | Token | Fast verdi: 6b9a21fb055343f8b10113a1b78b7229 (foreløpig fast, kan bli påkrevd i fremtidige versjoner) |
Svarformat
{"ret": 0, "data": 0}
| ret | data | Beskrivelse |
|---|---|---|
| 0 | - | Vellykket |
| 1 | 10 | Ukjent feil |
| 1 | 11 | Leketøy ikke tilkoblet |
| 1 | 12 | Lavt batteri på leketøyet |
Enkelt API
Vibrer leketøy
http://127.0.0.1:8089/vibrate?speed=num&time=msec
Funksjon
Vibrer leketøyet i msec millisekunder
Forespørselsmetode
GET
Forespørselsparametere
| Parameter | Beskrivelse | Verdier |
|---|---|---|
| speed | Hastighet | 0-100, 0 for å stoppe, 100 for maksimal intensitet |
| time | Tid | Millisekunder |
Eksempel
http://127.0.0.1:8089/vibrate?speed=20&time=1000
Begrensning
Minste intervall mellom to kommandoer er 100 ms
Roter leketøy
http://127.0.0.1:8089/rotate?speed=num&time=msec
Funksjon
Roter leketøyet i msec millisekunder
Forespørselsmetode
GET
Forespørselsparametere
| Parameter | Beskrivelse | Verdier |
|---|---|---|
| speed | Hastighet | 0-100, 0 for å stoppe, 100 for maksimal intensitet |
| time | Tid | Millisekunder |
Eksempel
http://127.0.0.1:8089/rotate?speed=20&time=1000
Stopp leketøy
http://127.0.0.1:8089/stop
Funksjon
Stopp alle handlinger på leketøyet
Forespørselsmetode
GET
Forespørselsparametere
Ingen
Mønster-API
Forhåndsinnstilte mønstre
http://127.0.0.1:8089/preset?id=num
Funksjon
Vibrer leketøyet med forhåndsdefinerte mønstre
Forespørselsmetode
GET
Forespørselsparametere
| Parameter | Beskrivelse | Verdier |
|---|---|---|
| id | Mønster-ID | 1 Pulse, 2 Wave, 3 Firework, 4 Earthquake |
Eksempel
http://127.0.0.1:8089/preset?id=1
Merknader
Leketøyet kan stoppes når som helst med det enkle API-et. Hvis det ikke stoppes, fortsetter leketøyet å gjenta mønsteret i det uendelige til batteriet er utladet.
Mønsterstrøm
http://127.0.0.1:8089/pattern
Funksjon
Send en serie kommandoer til leketøyet
Forespørselsmetode
POST
Forespørselsparametere
| Parameter | Beskrivelse | Verdier |
|---|---|---|
| data | Mønsterstrøm | Mønsterstrøm-streng (i forespørselskroppen) |
Eksempel
http://127.0.0.1:8089/pattern
Forespørselskropp
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;
Merknader
Mønsterstrømmer kan skrives tilpasset eller spilles inn i EnjoxRemote-appen ved å skyve fingeren.
Format for mønsterstrøm
En mønsterstrøm består av et mønsterhode og mønsterdata, atskilt med #. Beskrivelsen av mønsterhodet vises i tabellen nedenfor. Mønsterdata er en streng med kommaseparerte tallpar atskilt med semikolon, der hvert par tilsvarer handlingstypene i mønsterhodet (for eksempel, for F=v,r, inneholder hvert par verdier for vibrate og rotate).
| Nøkkelord | Innhold | Beskrivelse |
|---|---|---|
| V | 1 | Versjonsnummer |
| F | v,r | Handlingstyper: v = vibrate, r = rotate, p = contract |
| S | 100 | Tidsintervall i millisekunder |