README.md

Nstrumenta project example for code, data and sandbox use, including active commit webhook to GitHub.

Set up the project and link to the code repository

1. Fork this repository so you can make edits
2. Create a new project on https://nstrumenta.com
3. Add the repository you created to your project

Record Data

1. Open the Record page in your nstrumenta project
2. Configure inputs to record, for this example, open nstrumenta from a mobile phone and select the Device Motion input to record the inertial sensors on your device.
3. Click Start Recording, wave the device around to make an interesting log, and then click Stop Recording to finish the log

View Data

1. Your recording will be listing in the Data page in your nstrumenta project
2. clicking on the name will open a time series plot

Edit your code in VS Code

1. clone your repository locally
2. open the root folder in VS Code
3. install the nstrumenta VS Code extension
4. click on the grayed out VS Code logo in nstrumenta and select Init to initialize the connection
5. When successfully initialized, the logo will turn blue and you can ping to test the connection
6. use the nstrumenta.update command in VS Code to update your project with the latest from your repository

View your output in the Sandbox

1. Open the Sandboxes page in your nstrumenta project and click on the viewer-timeseries sandbox
2. Select the live-session that was created in the nstrumenta.update step
3. Check Use Dataflow, and select the recent-file dataflow and the live-session dataflow version
4. Click Run to run your latest recording through your latest algorithm

Develop and Collaborate

1. The Sandbox is now configured to live update with new changes from the algorithm or recordings. Even if they are contributed by other users of your project.