# braille_xr
refreshable braille display for rendering and input with handtracking

**[ disclaimer ]**  
this early repo may require special help/information depending on your setup and prior knowledge - so do not hesitate to reach out to [@spatialfree](https://x.com/spatialfree) with any questions!

## init
### required
- [dotnet sdk](https://dotnet.microsoft.com/en-us/download) v8
- [WiFi](https://github.com/espressif/arduino-esp32/tree/master/libraries/WiFi)
- [AsyncUDP](https://github.com/espressif/arduino-esp32/tree/master/libraries/AsyncUDP)
- [ESP32Servo](https://github.com/jkb-git/ESP32Servo)
### optional (*if you know what you are doing)  
- [vscode](https://https://code.visualstudio.com/)
- [arduino extension](https://marketplace.visualstudio.com/items?itemName=vsciot-vscode.vscode-arduino)

## setup
- enter your wifi credentials in ```hardware/braille_xr/_wifi_config.h``` --removing the leading underscore in the filename so it get's included in sketch (and gitignored)
```shell
# *on linux make sure you can r/w
sudo chmod 666 /dev/ttyUSB0
```
- open the serial monitor and upload the sketch to your board
- if successful after a series of connection codes it will print out the ip of your device and await input from the sk_demo
- before running the demo with ```dotnet run``` please replace the ip value in ```sk_demo/src/MonoNet.cs``` with your boards ip address

*currently the demo simply changes the displayed character as the tracked r_hand is moved along the x axis*

### hardware
- 6x 9g servos
- esp32 board / with breakout pins+power for the servos
- ...

## <3
[Bryan Chris Brown](https://twitter.com/BryanChrisBrown)  
[StereoNick](https://twitter.com/koujaku)  
[Peter Sassaman](https://twitter.com/PeterSassaman)  
[Lucas De Bonet (LucidVR)](https://twitter.com/VrLucid)