Enjox Toy HTTP-SDK-Dokumentation

Überblick

Drittanbieter-Apps können das Enjox HTTP-SDK nutzen, um die Toys anzusteuern.

Die HTTP-SDK-Funktionalität wird von der EnjoxRemote App bereitgestellt. Die EnjoxRemote App fungiert dabei als Bluetooth-↔-HTTP-Proxy, sodass du alle Toys auf demselben Handy (oder im selben Wi-Fi-Netzwerk) bequem über das Standard-HTTP-Protokoll steuern kannst. Nutzer müssen zuerst die EnjoxRemote App starten und erst danach deine App, um das HTTP-SDK verwenden zu können.

Architektur: Deine App kommuniziert über das HTTP-SDK mit der EnjoxRemote App, und die EnjoxRemote App kommuniziert über Bluetooth mit den Enjox Toys.

Testseite >>

Hinweis: Beim Zugriff über das Wi-Fi-Netzwerk ersetze 127.0.0.1 durch die IP-Adresse des Geräts, auf dem die EnjoxRemote App läuft. Der Standardport ist 8089.

Aufrufmethode

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

Anfragemethode

GET, POST

Anfrageparameter

Antwortformat

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

Einfache API

Toy vibrieren lassen

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

Funktion

Das Toy für msec Millisekunden vibrieren lassen

Anfragemethode

GET

Anfrageparameter

Beispiel

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

Einschränkung

Der minimale Abstand zwischen zwei Befehlen beträgt 100 ms

Toy rotieren lassen

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

Funktion

Das Toy für msec Millisekunden rotieren lassen

Anfragemethode

GET

Anfrageparameter

Beispiel

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

Toy stoppen

http://127.0.0.1:8089/stop

Funktion

Alle Toy-Aktionen stoppen

Anfragemethode

GET

Anfrageparameter

Keine

Pattern-API

Voreingestellte Muster

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

Funktion

Das Toy mit vordefinierten Mustern vibrieren lassen

Anfragemethode

GET

Anfrageparameter

Beispiel

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

Hinweise

Das Toy kann jederzeit über die Einfache API gestoppt werden. Wird es nicht gestoppt, wiederholt das Toy das Muster endlos, bis der Akku leer ist.

Pattern-Stream

http://127.0.0.1:8089/pattern

Funktion

Eine Reihe von Befehlen an das Toy senden

Anfragemethode

POST

Anfrageparameter

Beispiel

http://127.0.0.1:8089/pattern

Anfragetext

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;

Hinweise

Pattern-Streams können selbst geschrieben oder in der EnjoxRemote App durch Wischen mit dem Finger aufgezeichnet werden.

Pattern-Stream-Format

Ein Pattern-Stream besteht aus einem Pattern-Header und Pattern-Daten, getrennt durch #. Die Beschreibung des Pattern-Headers ist in der Tabelle unten dargestellt. Die Pattern-Daten sind eine Folge von Zahlenpaaren – die Zahlen innerhalb eines Paares durch Komma, die Paare untereinander durch Semikolon getrennt –, wobei die Werte eines Paares den im Pattern-Header definierten Aktionstypen entsprechen (z. B. enthält bei F=v,r jedes Paar je einen Wert für vibrate und rotate).