Skip to content

Commit 33b02d3

Browse files
committed
v3.0
* Documentation
1 parent 535c9e6 commit 33b02d3

File tree

2 files changed

+17
-4
lines changed

2 files changed

+17
-4
lines changed

README.md

+17-4
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,22 @@ fSensor!!.registerListener({ event -> filter!!.filter(event.values) }, sensorDel
5050

5151
See the sample app 'fsensorapp' for more examples.
5252

53+
## Orientation
54+
55+
FSensor conforms with the Android API such that the y-axis points north, the x-axis points east, and the z-axis points up. The device is assumed to be in the portrait orientation
56+
laying flat on a level surface.
57+
58+
* The orientation vector returned by FSensor will be orientation[]{azimuth, pitch, roll}.
59+
60+
* The linear acceleration returned by FSensor will be acceleration[]{x, y, z}.
61+
62+
<img src="/documentation/images/axis_device.png" width="300">
63+
64+
## Linear Acceleration
65+
66+
Linear acceleration is defined as linearAcceleration = (acceleration - gravity). An acceleration sensor alone is not capable of determining the difference between gravity/tilt.
67+
FSensor provides three different estimations of linear acceleration implementing Low-Pass, Complementary and Kalman based sensor fusions.
68+
5369
## Orientation Sensor Fusions
5470

5571
FSensor offers two different estimations of rotation implementing both Complementary and Kalman based fusions. The fusions utilize the acceleration, magnetic, and gyroscope sensors
@@ -134,8 +150,5 @@ FSensor uses a median filter designed to smooth the data points based on a time
134150
occur over a period defined by the time constant... the number of samples that are considered is known as the filter window. The approach allows the filter window to be defined
135151
over a period of time, instead of a fixed number of samples.
136152

137-
## Linear Acceleration
138-
139-
Linear acceleration is defined as linearAcceleration = (acceleration - gravity). An acceleration sensor alone is not capable of determining the difference between gravity/tilt.
140-
FSensor provides three different estimations of linear acceleration implementing Low-Pass, Complementary and Kalman based sensor fusions.
153+
141154

documentation/images/axis_device.png

11.5 KB
Loading

0 commit comments

Comments
 (0)