Main Page: Difference between revisions

From VibHub Wiki
Jump to navigation Jump to search
VisualWikitext
No edit summary
 
Jasx (talk | contribs)
46 edits
No edit summary
 
(5 intermediate revisions by the same user not shown)
Line 1: Line 1:
<strong>MediaWiki has been installed.</strong>
User Resources
{| class="wikitable"
|+
!Link
!Description
|-
|[[Product Comparison|VibHub Product Comparison]]
|See which kinds of VibHubs are available, and what their hardware specs are.
|-
|[[User Manual]]
|Learn how to use your VibHub!
|-
|[[Compatible toys|Toy Compatibility]]
|See what kind of toys you can use.
|-
|[[Wago Adapter|Using the VibHub Wago Adapter]]
|A fast snap adapter that lets you turn most 5V vibrators into smart ones.
|}


Consult the [https://www.mediawiki.org/wiki/Special:MyLanguage/Help:Contents User's Guide] for information on using the wiki software.
== Developer Resources ==
Welcome to the VibHub wiki! Before we start, let's go over some terms:
{| class="wikitable"
!Term
!Explanation
|-
|[[Firmware|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
|}


== Getting started ==
=== Source Code ===
* [https://www.mediawiki.org/wiki/Special:MyLanguage/Manual:Configuration_settings Configuration settings list]
{| class="wikitable"
* [https://www.mediawiki.org/wiki/Special:MyLanguage/Manual:FAQ MediaWiki FAQ]
!Name/Link
* [https://lists.wikimedia.org/postorius/lists/mediawiki-announce.lists.wikimedia.org/ MediaWiki release mailing list]
!Description
* [https://www.mediawiki.org/wiki/Special:MyLanguage/Localisation#Translation_resources Localise MediaWiki for your language]
|-
* [https://www.mediawiki.org/wiki/Special:MyLanguage/Manual:Combating_spam Learn how to combat spam on your wiki]
|[https://github.com/JasXSL/VibHub-Micro VibHub Micro]
|2026 Revision of the board. Featuring high res commands, 2 ports, and a built in rechargeable battery!
|-
|[https://github.com/JasXSL/VibHub-ESP32 VibHub ESP32]
|4xAA Version of the VibHub
|-
|[https://github.com/JasXSL/VibHub-Server VibHub Server]
|Host your own VibHub server!
|-
|[https://github.com/JasXSL/VibHub-Browser VibHub Browser]
|Official JS client library. See [[VibHub-Browser]] for documentation.
|-
|[https://github.com/JasXSL/SL-XOBJ/blob/master/xobj_core/classes/jas%20VibHub.lsl XOBJ SL Library]
|Second Life library built on the XOBJ framework
|-
|[https://github.com/JasXSL/VibHub-SocketDemo Browser Example]
|Example browser app that lets you run VibHub locally with just a few lines of code!
|}
 
=== 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.
|}

Latest revision as of 20:31, 26 March 2026

User Resources

Link Description
VibHub Product Comparison See which kinds of VibHubs are available, and what their hardware specs are.
User Manual Learn how to use your VibHub!
Toy Compatibility See what kind of toys you can use.
Using the VibHub Wago Adapter A fast snap adapter that lets you turn most 5V vibrators into smart ones.

Developer Resources

Welcome to the VibHub 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. See VibHub-Browser for documentation.
XOBJ SL Library Second Life library built on the XOBJ framework
Browser Example Example browser app that lets you run VibHub locally with just a few lines of code!

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.
Retrieved from "https://wiki.vibhub.io/index.php?title=Main_Page&oldid=36"