Dokumentation för Enjox Toy HTTP SDK

Översikt

Tredjepartsappar kan använda Enjox HTTP SDK för att få kontroll över leksakerna.

HTTP SDK-funktionaliteten tillhandahålls av EnjoxRemote-appen. I detta fall fungerar EnjoxRemote-appen som en Bluetooth ↔ HTTP-proxy, vilket gör att du enkelt kan styra alla leksaker på samma telefon (eller Wi-Fi-nätverk) via det vanliga HTTP-protokollet. Användarna måste först starta EnjoxRemote-appen innan de startar din app för att använda HTTP SDK.

Enjox HTTP SDK architecture: app to EnjoxRemote over HTTP, EnjoxRemote to toys over Bluetooth

Arkitektur: Din app kommunicerar med EnjoxRemote-appen via HTTP SDK, och EnjoxRemote-appen kommunicerar med Enjox-leksaker via Bluetooth.

Testsida >>

Obs: Vid åtkomst via Wi-Fi-nätverk, ersätt 127.0.0.1 med IP-adressen till den enhet som kör EnjoxRemote-appen. Standardporten är 8089.

Anropsmetod

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

Förfrågningsmetod

GET, POST

Förfrågningsparametrar

Parameter Beskrivning Värden
command Kommando vibrate, rotate, preset, pattern
param Parametrar Varierar beroende på kommandot
token Token Fast värde: 6b9a21fb055343f8b10113a1b78b7229 (för närvarande fast, kan krävas i framtida versioner)

Svarsformat

{"ret": 0, "data": 0}
ret data Beskrivning
0 - Lyckades
1 10 Okänt fel
1 11 Leksak ej ansluten
1 12 Lågt batteri i leksaken

Enkelt API

Få leksaken att vibrera

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

Funktion

Få leksaken att vibrera i msec millisekunder

Förfrågningsmetod

GET

Förfrågningsparametrar

Parameter Beskrivning Värden
speed Hastighet 0-100, 0 för att stoppa, 100 för maximal styrka
time Tid Millisekunder

Exempel

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

Begränsning

Minsta intervall mellan två kommandon är 100 ms

Få leksaken att rotera

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

Funktion

Få leksaken att rotera i msec millisekunder

Förfrågningsmetod

GET

Förfrågningsparametrar

Parameter Beskrivning Värden
speed Hastighet 0-100, 0 för att stoppa, 100 för maximal styrka
time Tid Millisekunder

Exempel

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

Stoppa leksaken

http://127.0.0.1:8089/stop

Funktion

Stoppa alla leksakens funktioner

Förfrågningsmetod

GET

Förfrågningsparametrar

Inga

Mönster-API

Förinställda mönster

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

Funktion

Få leksaken att vibrera med fördefinierade mönster

Förfrågningsmetod

GET

Förfrågningsparametrar

Parameter Beskrivning Värden
id Mönster-ID 1 Pulse, 2 Wave, 3 Firework, 4 Earthquake

Exempel

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

Anmärkningar

Leksaken kan stoppas när som helst med det enkla API:et. Om den inte stoppas fortsätter leksaken att upprepa mönstret i all oändlighet tills batteriet är slut.

Mönsterström

http://127.0.0.1:8089/pattern

Funktion

Skicka en serie kommandon till leksaken

Förfrågningsmetod

POST

Förfrågningsparametrar

Parameter Beskrivning Värden
data Mönsterström Mönsterströmssträng (i förfrågningskroppen)

Exempel

http://127.0.0.1:8089/pattern

Förfrågningskropp

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;

Anmärkningar

Mönsterströmmar kan skrivas anpassat eller spelas in i EnjoxRemote-appen genom att dra med fingret.

Mönsterströmsformat

En mönsterström består av ett mönsterhuvud och mönsterdata, åtskilda av #. Beskrivningen av mönsterhuvudet visas i tabellen nedan. Mönsterdata är en sträng med kommaseparerade talpar åtskilda av semikolon, där varje par motsvarar åtgärdstyperna i mönsterhuvudet (t.ex. för F=v,r innehåller varje par värden för vibrate och rotate).

Nyckelord Innehåll Beskrivning
V 1 Versionsnummer
F v,r Åtgärdstyper: v = vibrate, r = rotate, p = contract
S 100 Tidsintervall i millisekunder

Our site uses cookies. By continuing to use our site, you agree to the use of cookies. For more information about the use of cookies on our website, please see our Cookie Policy.