Skip to content

Commit

Permalink
doc: project - 📝 add README
Browse files Browse the repository at this point in the history
Signed-off-by: Pierre-Yves Lapersonne (Orange) <pierreyves.lapersonne@orange.com>
  • Loading branch information
pylapp committed Jul 25, 2019
1 parent 5bf2667 commit 1950f37
Show file tree
Hide file tree
Showing 9 changed files with 117 additions and 0 deletions.
117 changes: 117 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,117 @@
# Read me


## The aim of the project

The _Baah Box_ project has been created so as to provide to inpatent children and adults a fun solution to use so as to train their muscles or arms.
Indeed some people can have a missing arm, and are equiped by a prothesis. They need training to discover and train the muscles needed to control the prothesis.
Also people can be injuried and have to train again their muscles, arms or hands so as to recover their capabilities.


## The products

The common training tools are not fun, there are no games. We provide with Baah Box a solution with:

* a box with Arduino ships and a 3D printable shield, plugged to muscles sensors or joystick, connected in BLE to mobile apps
* an iOS app
* an Android app
* lovely assets


## Pictures of the project


### The Baah box

<table>
<tr>
<td>
<img
src="/~https://github.com/Orange-OpenSource/BaahBox-iOS/blob/master/doc/img_baahbox.jpg"
title="The Baah Box with 3D-printable shield connected in BLE to apps"
alt="The Baah Box with 3D-printable shield connected in BLE to apps"
width="400">
</td>
</tr>
</table>


### Pictures of the set up

<table>
<tr>
<td>
<img
src="/~https://github.com/Orange-OpenSource/BaahBox-iOS/blob/master/doc/img_setup_sensors.jpg"
alt="Sensors on arm to train plugged to the box connected in BLE to iOS app"
title="Sensors on arm to train plugged to the box connected in BLE to iOS app"
width="500">
</td>
<td>
<img
src="/~https://github.com/Orange-OpenSource/BaahBox-iOS/blob/master/doc/img_setup_joystick.jpeg"
alt="Set up with plates and joystick plugged to the box connected to the iPad"
title="Set up with plates and joystick plugged to the box connected to the iPad"
width="500">
</td>
</tr>
</table>


### Some mockups of the iOS app

<table>
<tr>
<td>
<img
src="/~https://github.com/Orange-OpenSource/BaahBox-Arduino/blob/master/doc/img_device_ios_menu.png"
title="The main menu of the iOS app"
alt="The main menu of the iOS app"
width="300">
</td>
<td>
<img
src="/~https://github.com/Orange-OpenSource/BaahBox-Arduino/blob/master/doc/img_device_ios_game_space.png"
title="The space game in the iOS app"
alt="The space game in the iOS app"
width="300">
</td>
</tr>
</table>


### Some mockups of the Android app

<table>
<tr>
<td>
<img
src="/~https://github.com/Orange-OpenSource/BaahBox-Arduino/blob/master/doc/img_device_android_menu.png"
title="The main menu of the Android app"
alt="The main menu of the Android app"
width="300">
</td>
<td>
<img
src="/~https://github.com/Orange-OpenSource/BaahBox-Arduino/blob/master/doc/img_device_android_game_balloon.png"
title="The ballon game in the Android app"
alt="The ballon game in the Android app"
width="300">
</td>
</tr>
</table>


## More links

Here are four links pointing to all sides of the project.

* The Arduino firmware: /~https://github.com/Orange-OpenSource/BaahBox-Arduino
* The iOS code: /~https://github.com/Orange-OpenSource/BaahBox-iOS
* The Android code: /~https://github.com/Orange-OpenSource/BaahBox-Android
* The assets: /~https://github.com/Orange-OpenSource/BaahBox-assets


## About stores

Keep an eye here, we'll deliver the apps on stores soon ;-)
Binary file added doc/img_baahbox.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/img_device_android_game_balloon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/img_device_android_menu.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/img_device_ios_game_space.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/img_device_ios_menu.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/img_setup_joystick.jpeg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/img_setup_sensors.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 1950f37

Please sign in to comment.