Skip to content

Commit

Permalink
2 setup ci with actions (#4)
Browse files Browse the repository at this point in the history
* Add workflow
* Add CI test
* Save work
* Add graph samples from testing
* Add docs
  • Loading branch information
iconnor authored May 12, 2023
1 parent 1eec286 commit 4c2cf5a
Show file tree
Hide file tree
Showing 7 changed files with 440 additions and 0 deletions.
66 changes: 66 additions & 0 deletions GETTING_STARTED.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
# Getting Started with the Impact Sensor Monitor

Welcome to our Impact Sensor Monitor system! This guide will help you get started with setting up and using your new sensor to monitor potential head injury risks.

## Table of Contents

- [Getting Started with the Impact Sensor Monitor](#getting-started-with-the-impact-sensor-monitor)
- [Table of Contents](#table-of-contents)
- [Requirements](#requirements)
- [Setting Up Your Sensor](#setting-up-your-sensor)
- [Monitoring with the Website](#monitoring-with-the-website)
- [Viewing Data](#viewing-data)
- [Exporting Data](#exporting-data)
- [Support](#support)

## Requirements

Before you start, make sure you have the following:

1. An MPU-6050 sensor.
2. An Android device with a BLE-supported browser (e.g. Chrome).
3. The sensor should be charged and within range of your device.

## Setting Up Your Sensor

To set up your sensor:

1. Turn on your NRF51/MPU-6050 sensor.
2. Attach the sensor securely to the player's head or body. Make sure it is positioned correctly and comfortably.

## Monitoring with the Website

To start monitoring:

1. Open your BLE-supported browser and navigate to our website.
2. Click the "Start Monitoring" button. This will initiate the pairing process with your sensor.
3. Once the sensor is paired, the website will start recording acceleration data.

To restart monitoring:

1. Click the "Restart Monitoring" button on the website. This will reset the data and start a new monitoring session.

## Viewing Data

To view the real-time data:

1. Navigate to the "Data Visualization" section on the website.
2. Here, you can see a real-time graphical representation of the acceleration data.

![Sample graph](images/tracking-session.gif)

## Exporting Data

To export the recorded data:

1. Navigate to the "Data Export" section on the website.
2. Click the "Export to CSV" button.
3. The data will be downloaded as a CSV file to your device.

## Support

If you encounter any issues or have any questions, feel free to contact our support team.

---

Remember, this is just a template. You should modify it to match the actual user interface and functionality of your system.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,11 +35,19 @@ This project aims to provide a simple and affordable way to measure and monitor
## Example tag

Sample image of a tag that can be purchased.

| Front | Back |
| ----- | ----- |
| ![Front of tag](images/front-tag.jpg) | ![Back of tag](images/back-tag.jpg) It is good to check for programming pins before you buy one. |


## Sample monitor session

Sample output from the serial monitor:
![Sample monitor session](images/sample-monitor-session.gif)

Sample graph of acceleration values:
![Sample graph](images/sample-graph.png)

## License

Expand Down
Loading

0 comments on commit 4c2cf5a

Please sign in to comment.