Skip to content

Commit 1dbd702

Browse files
committed
docs: Update README.md
Organised and added images to the "Usage" section.
1 parent f9d4391 commit 1dbd702

2 files changed

Lines changed: 36 additions & 1 deletion

File tree

README.md

Lines changed: 36 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,14 @@
6565
<li><a href="#package-installation-and-venv">Step 2: Package Installation & Environment</a></li>
6666
</ul>
6767
</li>
68-
<li><a href="#usage">Usage</a></li>
68+
<li>
69+
<a href="#usage">Usage</a>
70+
<ul>
71+
<li><a href="#hardware-setup">Hardware Setup</a></li>
72+
<li><a href="#example-scripts">Example Scripts</a></li>
73+
<li><a href="#further-information">Further Information</a></li>
74+
</ul>
75+
</li>
6976
<li><a href="#contributing">Contributing</a>
7077
<ul>
7178
<li><a href="#how-to-contribute">How to Contribute</a></li>
@@ -169,10 +176,14 @@ your Python environment, by using the `setup.py` script.
169176
<!-- USAGE EXAMPLES -->
170177
## Usage
171178

179+
### Hardware Setup
180+
172181
To get started, [set up the hardware][url-documentation-setup-hw]. This involves connecting the device dongle to your
173182
PC or laptop, and turning ON the controllers. You will know they are connected if the device dongle keeps blinking in
174183
the following pattern: pink-pink-blue.
175184

185+
### Example Scripts
186+
176187
If you followed the previous steps on installation, you should be able to run any example scripts.
177188

178189
1. Open a command prompt.
@@ -183,6 +194,29 @@ If you followed the previous steps on installation, you should be able to run an
183194
python example_script_name.py
184195
```
185196

197+
### Further Information
198+
199+
With this API, you will be able to retrieve a wide range of [data from the controllers][url-documentation-data]:
200+
* **Tactile data**: individual finger curling and pressure, trackpad, slider LED, tracker (connection, proximity sensor; no positional tracking) and system button.
201+
202+
<p align="center">
203+
<img width="700" src="./img/etee-controller-sensors.jpg">
204+
<br/>
205+
<em>Tactile and sensing data from the controller.</em>
206+
</p>
207+
208+
* **Gestures**: grip, pinch and point gestures.
209+
210+
<p align="center">
211+
<img width="700" src="./img/etee-gestures.jpg">
212+
<br/>
213+
<em>Main etee gestures.</em>
214+
</p>
215+
216+
* **Inertial Measuring Units (IMU) and 3D rotation**: raw 9-axis IMU data (accelerometer, gyroscope, magnetometer data) and 3D rotation estimations (quaternion, euler angles).
217+
* **Device State**: right or left hand.
218+
* **Battery State**: charge level, charge status.
219+
186220
We also have [quickstart][url-documentation-quickstart] and [more detailed developer guides][url-documentation-api-functions]
187221
in our documentation page. This might help you understand the different API functionalities and how to integrate them
188222
in your custom applications.
@@ -287,6 +321,7 @@ For further support or queries, you can contact us:
287321
[url-documentation-setup-hw]: https://tg0-etee-python-api.readthedocs-hosted.com/en/latest/setup.html
288322
[url-documentation-quickstart]: https://tg0-etee-python-api.readthedocs-hosted.com/en/latest/quickstart.html
289323
[url-documentation-api-functions]: https://tg0-etee-python-api.readthedocs-hosted.com/en/latest/guide.html
324+
[url-documentation-data]: https://tg0-etee-python-api.readthedocs-hosted.com/en/latest/serial.html#etee-packet-elements
290325
[url-issues-tab]: https://github.com/eteeXR/etee-Python-API/issues
291326
[url-python-venv]: https://docs.python.org/3/tutorial/venv.html
292327
[url-python-package-installation]: https://packaging.python.org/en/latest/tutorials/installing-packages/

0 commit comments

Comments
 (0)