Initial improvements for use cases document #256
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
alexshalamov
force-pushed
the
improve_use_cases
branch
from
4e489a8
to
2c03e01
Compare
anssiko
approved these changes
Aug 23, 2017
usecases.bs
Outdated
|
|
||
|
|
||
| Use Cases {#usecases} | ||
| Use Cases and requeiements {#usecases-and-requirements} |
usecases.bs
Outdated
| ===================== | ||
|
|
||
| Displaying the position of the user on a map in real time {#display-realtime} | ||
| --------------------- | ||
| The use cases and requirements for the sensors may differ from one application to another. In |
usecases.bs
Outdated
|
|
||
| Environmental sensors might be used in applications like: home automation, accesibility, personal |
usecases.bs
Outdated
|
|
||
| Using the proposed Generic Sensor API, application level code looks like this: | ||
| - [=Ambient light sensor=] |
There was a problem hiding this comment.
usecases.bs
Outdated
| Using the proposed Generic Sensor API, application level code looks like this: | ||
| - [=Ambient light sensor=] | ||
| - [=Proximity sensor=] | ||
| - [=Magnetometer=] |
There was a problem hiding this comment.
usecases.bs
Outdated
|
|
||
| <div class="example"> | ||
| In this example, we create simple linear free fall detection sensor. |
usecases.bs
Outdated
| In this example, we create simple linear free fall detection sensor. | ||
|
|
||
| <pre highlight="js"> | ||
| class FreeFallSensor extends Accelerometer { |
There was a problem hiding this comment.
Ping @kenchris to review the JS code style of the examples.
usecases.bs
Outdated
|
|
||
| <div class="example"> | ||
| In this simplified example, we define FusionSensor class that aggregates multiple sources and |
usecases.bs
Outdated
| } | ||
|
|
||
| // Stateful algorithm that finds brightest spot during calibration phase and uses | ||
| // it as a fixed frame of reference to calculate relative orientation from brigtest |
usecases.bs
Outdated
|
|
||
| - Reed switch and hall effect sensors | ||
| - Significant motion, no motion, tap, flat, free fall, low-g and high-g sensors | ||
| - Laser or infrared switch sensors | ||
|
|
||
| Security and Privacy Considerations {#security-and-privacy} |
There was a problem hiding this comment.
We can remove this section from this use cases document, needed only for API specs.
There was a problem hiding this comment.
@anssiko I removed it initially, but then, bikeshed throws an error.
There was a problem hiding this comment.
You can try Status: NOTE, and see if that helps. Or build with -f.
anssiko
reviewed
Aug 24, 2017
usecases.bs
Outdated
| } | ||
| } | ||
|
|
||
| get inFreeFall { |
There was a problem hiding this comment.
inFreeFall() as pointed out elsewhere.
pozdnyakov
reviewed
Aug 24, 2017
usecases.bs
Outdated
|
|
||
| This group of sensors is based on inertia and relevant measuring concepts. Usually, inertial | ||
| sensors are part of IMU (Inertial Measurements Unit) that measure [=acceleration=] using | ||
| accelerometer and [=rotational rate=] using gyroscope. [=Magnetometer=] might be part of IMU and |
pozdnyakov
reviewed
Aug 24, 2017
usecases.bs
Outdated
| set onreading(func) { | ||
| super.onreading = () => { | ||
| this.inFreeFall_ = Math.hypot(super.x, super.y, super.z) < 0.5; | ||
| func(); |
There was a problem hiding this comment.
shouldn't func() be called optionally?
|
My review comments have been addressed, feel free to land this @alexshalamov. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #181