js-sensor/index.html at master · theopenwebjp/js-sensor · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
<html>
    <head>
        <title>JavaScript Sensor Abstraction js-sensor</title>
    </head>
    <body>
        <h1>JavaScript Sensor Abstraction js-sensor</h1>

        <div>
            <h2>Introduction</h2>
            <div>
                JavaScript offers a variety of APIs for accessing device sensor data.
                Obtaining this data is often done in similar but slightly different ways.
                Sometimes, an easy way to get all the desired sensor data at once with little interest in the underlying mechanism is desired.

                This library offers just this by abstracting JavaScript sensor events into a simple API.
            </div>
        </div>

        <div>
            <h2>Setup</h2>
            <div>
                1. Download bundle.js from ./dist folder or build
                2. npm install @theopenwebjp/js-sensor
                3. const JsSensor = require('js-sensor'); // OR use global from dist file.
                4. Done!
            </div>
        </div>

        <div>
            <h2>Usage</h2>
            <div>
                const JsSensor = require('js-sensor');
                JsSensor.watch
                JsSensor.get
                JsSensor.stop
            </div>
        </div>

        <div>
            <h2>Examples</h2>
            <div>
                <a href="./example/">Sensor examples page</a>
            </div>
        </div>

        <div>
            <h2>Build</h2>
            <div>
                npm run build-all
            </div>
        </div>

        <div>
            <h2>Test</h2>
            <div>
                npm run test
            </div>
        </div>
    </body>
</html>