Τεκμηρίωση HTTP SDK για τα παιχνίδια Enjox
Επισκόπηση
Εφαρμογές τρίτων μπορούν να χρησιμοποιήσουν το Enjox HTTP SDK για να αποκτήσουν δυνατότητες ελέγχου των παιχνιδιών.
Η λειτουργικότητα του HTTP SDK παρέχεται από την εφαρμογή EnjoxRemote. Σε αυτή την περίπτωση, η εφαρμογή EnjoxRemote λειτουργεί ως διαμεσολαβητής Bluetooth ↔ HTTP, επιτρέποντάς σου να ελέγχεις εύκολα όλα τα παιχνίδια στο ίδιο τηλέφωνο (ή δίκτυο Wi-Fi) μέσω του τυπικού πρωτοκόλλου HTTP. Οι χρήστες πρέπει πρώτα να εκκινήσουν την εφαρμογή EnjoxRemote πριν εκκινήσουν τη δική σου εφαρμογή για να χρησιμοποιήσουν το HTTP SDK.

Αρχιτεκτονική: Η εφαρμογή σου επικοινωνεί με την εφαρμογή EnjoxRemote μέσω του HTTP SDK, και η εφαρμογή EnjoxRemote επικοινωνεί με τα παιχνίδια Enjox μέσω Bluetooth.
Σημείωση: Όταν συνδέεσαι μέσω δικτύου Wi-Fi, αντικατέστησε το 127.0.0.1 με τη διεύθυνση IP της συσκευής στην οποία τρέχει η εφαρμογή EnjoxRemote. Η προεπιλεγμένη θύρα είναι 8089.
Μέθοδος κλήσης
http://127.0.0.1:8089/{command}?param=value[&token=xxx]
Μέθοδος αιτήματος
GET, POST
Παράμετροι αιτήματος
| Παράμετρος | Περιγραφή | Τιμές |
|---|---|---|
| command | Εντολή | vibrate, rotate, preset, pattern |
| param | Παράμετροι | Διαφέρει ανάλογα με την εντολή |
| token | Token | Σταθερή τιμή: 6b9a21fb055343f8b10113a1b78b7229 (προς το παρόν σταθερή, μπορεί να απαιτείται σε μελλοντικές εκδόσεις) |
Μορφή απόκρισης
{"ret": 0, "data": 0}
| ret | data | Περιγραφή |
|---|---|---|
| 0 | - | Επιτυχία |
| 1 | 10 | Άγνωστο σφάλμα |
| 1 | 11 | Το παιχνίδι δεν είναι συνδεδεμένο |
| 1 | 12 | Χαμηλή μπαταρία παιχνιδιού |
Απλό API
Δόνηση παιχνιδιού
http://127.0.0.1:8089/vibrate?speed=num&time=msec
Λειτουργία
Δόνηση του παιχνιδιού για msec χιλιοστά του δευτερολέπτου
Μέθοδος αιτήματος
GET
Παράμετροι αιτήματος
| Παράμετρος | Περιγραφή | Τιμές |
|---|---|---|
| speed | Ταχύτητα | 0-100, 0 για διακοπή, 100 για μέγιστη ένταση |
| time | Χρόνος | Χιλιοστά του δευτερολέπτου |
Παράδειγμα
http://127.0.0.1:8089/vibrate?speed=20&time=1000
Περιορισμός
Το ελάχιστο διάστημα ανάμεσα σε δύο εντολές είναι 100ms
Περιστροφή παιχνιδιού
http://127.0.0.1:8089/rotate?speed=num&time=msec
Λειτουργία
Περιστροφή του παιχνιδιού για msec χιλιοστά του δευτερολέπτου
Μέθοδος αιτήματος
GET
Παράμετροι αιτήματος
| Παράμετρος | Περιγραφή | Τιμές |
|---|---|---|
| speed | Ταχύτητα | 0-100, 0 για διακοπή, 100 για μέγιστη ένταση |
| time | Χρόνος | Χιλιοστά του δευτερολέπτου |
Παράδειγμα
http://127.0.0.1:8089/rotate?speed=20&time=1000
Διακοπή παιχνιδιού
http://127.0.0.1:8089/stop
Λειτουργία
Διακοπή όλων των ενεργειών του παιχνιδιού
Μέθοδος αιτήματος
GET
Παράμετροι αιτήματος
Καμία
Pattern API
Προκαθορισμένα μοτίβα
http://127.0.0.1:8089/preset?id=num
Λειτουργία
Δόνηση του παιχνιδιού με προκαθορισμένα μοτίβα
Μέθοδος αιτήματος
GET
Παράμετροι αιτήματος
| Παράμετρος | Περιγραφή | Τιμές |
|---|---|---|
| id | ID μοτίβου | 1 Pulse, 2 Wave, 3 Firework, 4 Earthquake |
Παράδειγμα
http://127.0.0.1:8089/preset?id=1
Σημειώσεις
Το παιχνίδι μπορεί να σταματήσει οποιαδήποτε στιγμή χρησιμοποιώντας το Απλό API. Αν δεν σταματήσει, το παιχνίδι θα συνεχίσει να επαναλαμβάνει το μοτίβο επ' αόριστον μέχρι να εξαντληθεί η μπαταρία.
Ροή μοτίβου
http://127.0.0.1:8089/pattern
Λειτουργία
Αποστολή μιας σειράς εντολών στο παιχνίδι
Μέθοδος αιτήματος
POST
Παράμετροι αιτήματος
| Παράμετρος | Περιγραφή | Τιμές |
|---|---|---|
| data | Ροή μοτίβου | Συμβολοσειρά ροής μοτίβου (στο σώμα του αιτήματος) |
Παράδειγμα
http://127.0.0.1:8089/pattern
Σώμα αιτήματος
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;
Σημειώσεις
Οι ροές μοτίβων μπορούν να γραφτούν προσαρμοσμένα ή να καταγραφούν στην εφαρμογή EnjoxRemote σύροντας το δάχτυλό σου.
Μορφή ροής μοτίβου
Μια ροή μοτίβου αποτελείται από μια κεφαλίδα μοτίβου και δεδομένα μοτίβου, χωρισμένα με #. Η περιγραφή της κεφαλίδας μοτίβου φαίνεται στον παρακάτω πίνακα. Τα δεδομένα μοτίβου είναι μια συμβολοσειρά από ζεύγη αριθμών χωρισμένα με κόμματα και διαχωρισμένα με ερωτηματικά, με κάθε ζεύγος να αντιστοιχεί στους τύπους ενεργειών της κεφαλίδας μοτίβου (π.χ., για F=v,r, κάθε ζεύγος περιέχει τιμές για δόνηση και περιστροφή).
| Λέξη-κλειδί | Περιεχόμενο | Περιγραφή |
|---|---|---|
| V | 1 | Αριθμός έκδοσης |
| F | v,r | Τύποι ενεργειών: v = δόνηση, r = περιστροφή, p = σύσπαση |
| S | 100 | Χρονικό διάστημα σε χιλιοστά του δευτερολέπτου |