Skip to content

Commit 3bc2234

Browse files
committed
docs: Reorganise Content & Change Shields
- Moved 'available controller data' section to the top - Automatic shields removed for now
1 parent ef094d3 commit 3bc2234

1 file changed

Lines changed: 23 additions & 24 deletions

File tree

README.md

Lines changed: 23 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -30,10 +30,10 @@
3030
<img src="https://img.shields.io/badge/docs-etee_Python_API-lightgrey"
3131
alt="Check our Docs!"></a>
3232
<a>
33-
<img src="https://img.shields.io/github/v/tag/eteexr/etee-Python-API"
33+
<img src="https://img.shields.io/badge/release-v.1.0.0--alpha-green"
3434
alt="Tag for latest stable release"></a>
3535
<a>
36-
<img src="https://img.shields.io/github/license/eteexr/etee-Python-API"
36+
<img src="https://img.shields.io/badge/license-Apache 2.0-red"
3737
alt="License"></a>
3838
</p>
3939

@@ -96,6 +96,27 @@ In this repository, you can access:
9696
- etee Python API example scripts
9797
- Setup files
9898

99+
With this API, you will be able to retrieve a wide range of [data from the controllers][url-documentation-data]:
100+
* **Tactile data**: individual finger curling and pressure, trackpad, slider LED, tracker (connection, proximity sensor; no positional tracking) and system button.
101+
102+
<p align="center">
103+
<img width="700" src="./img/etee-controller-sensors.jpg">
104+
<br/>
105+
<em>Tactile and sensing data from the controller.</em>
106+
</p>
107+
108+
* **Gestures**: grip, pinch and point gestures.
109+
110+
<p align="center">
111+
<img width="700" src="./img/etee-gestures.jpg">
112+
<br/>
113+
<em>Main etee gestures.</em>
114+
</p>
115+
116+
* **Inertial Measuring Units (IMU) and 3D rotation**: raw 9-axis IMU data (accelerometer, gyroscope, magnetometer data) and 3D rotation estimations (quaternion, euler angles).
117+
* **Device State**: right or left hand.
118+
* **Battery State**: charge level, charge status.
119+
99120
For more information, please, visit our documentation site:
100121
[Developer Documentation - etee Python API][url-documentation]
101122

@@ -195,28 +216,6 @@ If you followed the previous steps on installation, you should be able to run an
195216
```
196217

197218
### 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-
220219
We also have [quickstart][url-documentation-quickstart] and [more detailed developer guides][url-documentation-api-functions]
221220
in our documentation page. This might help you understand the different API functionalities and how to integrate them
222221
in your custom applications.

0 commit comments

Comments
 (0)