Main Page: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 4: | Line 4: | ||
!Explanation | !Explanation | ||
|- | |- | ||
|Device | |[[Firmware|Device]] | ||
|This is the physical hardware VibHub | |This is the physical hardware VibHub, and also refers to the firmware. | ||
|- | |- | ||
|App | |[[App]] | ||
|The code that sends vibration instructions to the Device | |The code that sends vibration instructions to the Device. This is likely what you're here for! See the API documentation below! | ||
|- | |- | ||
|Server | |[[Server]] | ||
|This is the server that relays messages between the Device and the App | |This is the server that relays messages between the Device and the App. You can host your own! | ||
|- | |- | ||
|deviceID | |deviceID | ||
| Line 39: | Line 39: | ||
|[https://github.com/JasXSL/VibHub-SocketDemo Browser Example] | |[https://github.com/JasXSL/VibHub-SocketDemo Browser Example] | ||
|Example browser app that you can run locally | |Example browser app that you can run locally | ||
|} | |||
== API == | |||
{| class="wikitable" | |||
|+ | |||
!API Type | |||
!Description | |||
|- | |||
|[[REST]] | |||
|Lets you send vibration programs to a device through simple HTTP requests. | |||
|- | |||
|[[Web Sockets]] | |||
|Much faster than REST requests, recommended if your platform supports it! | |||
|- | |||
|[[Tasks|Tasks Reference]] | |||
|Tasks that your device can handle. | |||
|} | |} | ||
Revision as of 11:13, 29 January 2026
Welcome to the VibHub developer wiki! Before we start, let's go over some terms:
| Term | Explanation |
|---|---|
| Device | This is the physical hardware VibHub, and also refers to the firmware. |
| App | The code that sends vibration instructions to the Device. This is likely what you're here for! See the API documentation below! |
| Server | This is the server that relays messages between the Device and the App. You can host your own! |
| deviceID | A unique ID for each Device that allows the App to communicate with it |
Source Code
| Name/Link | Description |
|---|---|
| VibHub Micro | 2026 Revision of the board. Featuring high res commands, 2 ports, and a built in rechargeable battery! |
| VibHub ESP32 | 4xAA Version of the VibHub |
| VibHub Server | Host your own VibHub server! |
| VibHub Browser | Official JS client library |
| XOBJ SL Library | Second Life library built on the XOBJ framework |
| Browser Example | Example browser app that you can run locally |
API
| API Type | Description |
|---|---|
| REST | Lets you send vibration programs to a device through simple HTTP requests. |
| Web Sockets | Much faster than REST requests, recommended if your platform supports it! |
| Tasks Reference | Tasks that your device can handle. |