Skip to content
Snippets Groups Projects
Commit d9b1d158 authored by Nathan Adams's avatar Nathan Adams
Browse files

updated readme with slightly more detailed build instructions

parent 130f9bad
Branches
No related merge requests found
...@@ -11,15 +11,91 @@ Wireless IMU that sends OSC messages - based on the HUZZAH32 and Fusion 9DoF bre ...@@ -11,15 +11,91 @@ Wireless IMU that sends OSC messages - based on the HUZZAH32 and Fusion 9DoF bre
### Hardware ### Hardware
https://www.adafruit.com/product/2472 Detailed build guide can be found here [buildGuide]
### Software ### Software
Install the following Arduino libraries #### Prerequistes
In order to build the software, you need to have carried out the following steps.
1. Download and install the Arduino development environment from [arduino]
1. Install espressif for Arduino - instructions are here [esp32]
2. Install the following libraries
1. OSC
2. Adafruit BNO055
3. Adafruit Unified Sensor Library
The adafruit libraries, like the espressif software require a URL adding to the preferences of the Arduino environment, you can find instructions for this here [adafruit_libs]
#### OSCIMU
Download or clone this repository.
The arduino sketch is in the folder OSCIMU of this repository, in which you should find
* OSCIMU.ino[oscimu]
* secrets.template.h[secrets]
You need to create a `secrets.h` file from `secrets.template.h`, you can do this on the command line with
```
cd [DOWNLOAD_LOCATION]/oscimu/OSCIMU
cp secrets.template.h secrets.h
```
(changing donwload location to where you have downloaded the repository to)
You should see the secrets file in the arduino editor (it won't show if you had openend OSCIMU.ino already, so close it and repoen it)
![arduino tabs for include files][arduinoTabs]
The secrets.h file contains details of the wireless network you want to join, had has the following entries
|Name |Description |Value |
|-----|---------------------------|----------------------|
|SECRET_SSID|Name of the wireless network you want to join |Name in quotes|
|SECRET_PASSWORD|Password of the wireless network |Password in quotes|
|SECRET_IP|This is the IP address the computer you want to send OSC messages to on the wireless network| Ip address, e.g. `10, 100, 101, 123` - note use of commas and not periods|
|SECRET_PORT|Recieving port|This is the port you want to send to, and matches the one you set up in max|
Notes:
1. Currently only works for Wireless netorks which have a password only access, which means we can't currently use with Eduroam, this is on the list of things to be be looked at
Once you'ce created and updated the `secrets.h` file, you can then build it and upload the code to your completed board.
Make sure you have selected the `Adafruit ESP32 Feather` from the Boards menu - it's in the ESP32 section about a third of the way down the list after `Onehorse ESP32 Dev Module`
![list of ESP32 boards][boardList]
The default settings can be acceoted for all other items that now appear in the boards menu - and they are as follows
![board settings][boardSettings]
Make sure you've picked the right port, for a mac this is something like `/dev/cu.SLAB_USBtoUART`
If the code has uploaded OK, you'll see various messages in the console ending in `Hard resetting via RST pin`
If you now open Serial monitor, set the baud rate to `115200` and press the reset button on the Huzzah32 board, you should see messages which confirm.
1. Connection to the Wireless network
2. If the BNO055 board was found
If you don't see these then check out the trouble shooting guide.
[buildGuide]:BuildGuide.pdf
[arduino]:https://www.arduino.cc/en/Main/Software
[esp32]:https://github.com/espressif/arduino-esp32/blob/master/docs/arduino-ide/boards_manager.md
[adafruit_libs]:https://learn.adafruit.com/adafruit-all-about-arduino-libraries-install-use/library-manager
[oscimu]:OSCIMU/OSCIMU.ino
[secrets]:OSCIMU/secrets.template.h
ESP32 (requires new path in Arduino preferences) [arduinoTabs]:_buildGuide/images/arduinoTabs.png
OSC [boardList]:_buildGuide/images/boardList.png
Adafruit Sensor Library [boardSettings]:_buildGuide/images/boardSettings.png
\ No newline at end of file
_buildGuide/images/arduinoTabs.png

13.9 KiB

_buildGuide/images/boardList.png

179 KiB

_buildGuide/images/boardSettings.png

90.3 KiB

0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment