Skip to content

Commit 90d6527

Browse files
hs0225yichoi
hs0225
authored and
yichoi
committed
Update documents (#1581)
I circled only proven test from 'iotjs-test-results' on Platform Support table. IoT.js-DCO-1.0-Signed-off-by: Hosung Kim [email protected]
1 parent 2a1f439 commit 90d6527

24 files changed

+192
-189
lines changed

‎docs/Getting-Started.md

+4-5
Original file line numberDiff line numberDiff line change
@@ -4,18 +4,17 @@ Current supported platforms are **Linux and NuttX**
44
OSX 10.10 as development host
55

66
* [Build for x86 / Linux](build/Build-for-x86-Linux.md): Ubuntu 14.04 is used as a base platform.
7+
* [Build for Raspberry Pi 3 / Tizen](build/Build-for-RPi3-Tizen.md)
78
* [Build for Stm32f4 / NuttX](build/Build-for-STM32F4-NuttX.md)
89
* [Build for Raspberry Pi 2 / Linux](build/Build-for-RPi2-Linux.md)
9-
* [Build for Artik053 / TizenRT](build/Build-for-ARTIK053-TizenRT)
10+
* [Build for ARTIK053 / TizenRT](build/Build-for-ARTIK053-TizenRT.md)
1011

1112
#### H/W boards
1213
* Current supporting
1314
* STM32F4-Discovery + BB
1415
* Raspberry Pi 2
15-
* Plan to support
16-
* Samsung Artik 053
17-
* Samsung Artik 10
18-
* (and your contributions including above plans)
16+
* Raspberry Pi 3
17+
* Samsung ARTIK 053
1918

2019
We will support the correct behavior of APIs for above environments. However, since IoT.js is targeting various kind IoT devices and platforms, single implementation cannot be the best practice for every environments. Therefore embedders should be in charge of optimization for their own environments. For more details on optimization, see the [Optimization Tips](devs/Optimization-Tips.md) page.
2120

‎docs/README.md

+2
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,9 @@ Welcome to the IoT.js!
1313
**[Getting Started](Getting-Started.md)**
1414
- [x86 / Linux](build/Build-for-x86-Linux.md)
1515
- [Raspberry Pi 2 / Linux](build/Build-for-RPi2-Linux.md)
16+
- [Raspberry Pi 3 / Tizen](build/Build-for-RPi3-Tizen.md)
1617
- [Stm32f4 / NuttX](build/Build-for-STM32F4-NuttX.md)
18+
- [ARTIK053 / TizenRT](build/Build-for-ARTIK053-TizenRT.md)
1719

1820
**[Developer Guide](Developer's-Guide.md)**
1921
- [Development Process](devs/Development-Process.md)

‎docs/api/IoT.js-API-ADC.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,14 @@
22

33
The following table shows ADC module APIs available for each platform.
44

5-
| | Linux<br/>(Ubuntu) | Raspbian<br/>(Raspberry Pi) | NuttX<br/>(STM32F4-Discovery) | TizenRT<br/>(Artik053) |
6-
| :---: | :---: | :---: | :---: | :---: |
7-
| adc.open | O | X | O | O |
8-
| adc.openSync | O | X | O | O |
9-
| adcpin.read | O | X | O | O |
10-
| adcpin.readSync | O | X | O | O |
11-
| adcpin.close | O | X | O | O |
12-
| adcpin.closeSync | O | X | O | O |
5+
| | Linux<br/>(Ubuntu) | Tizen<br/>(Raspberry Pi) | Raspbian<br/>(Raspberry Pi) | NuttX<br/>(STM32F4-Discovery) | TizenRT<br/>(Artik053) |
6+
| :---: | :---: | :---: | :---: | :---: | :---: |
7+
| adc.open | X | X | X | O | O |
8+
| adc.openSync | X | X | X | O | O |
9+
| adcpin.read | X | X | X | O | O |
10+
| adcpin.readSync | X | X | X | O | O |
11+
| adcpin.close | X | X | X | O | O |
12+
| adcpin.closeSync | X | X | X | O | O |
1313

1414

1515
# ADC

‎docs/api/IoT.js-API-Assert.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,16 @@
22

33
The following shows Assert module APIs available for each platform.
44

5-
| | Linux<br/>(Ubuntu) | Raspbian<br/>(Raspberry Pi) | NuttX<br/>(STM32F4-Discovery) | TizenRT<br/>(Artik053) |
6-
| :---: | :---: | :---: | :---: | :---: |
7-
| assert.assert | O | O | O | O |
8-
| assert.doesNotThrow | O | O | O | O |
9-
| assert.equal | O | O | O | O |
10-
| assert.fail | O | O | O | O |
11-
| assert.notEqual | O | O | O | O |
12-
| assert.notStrictEqual | O | O | O | O |
13-
| assert.strictEqual | O | O | O | O |
14-
| assert.throws | O | O | O | O |
5+
| | Linux<br/>(Ubuntu) | Tizen<br/>(Raspberry Pi) | Raspbian<br/>(Raspberry Pi) | NuttX<br/>(STM32F4-Discovery) | TizenRT<br/>(Artik053) |
6+
| :---: | :---: | :---: | :---: | :---: | :---: |
7+
| assert.assert | O | O | O | O | O |
8+
| assert.doesNotThrow | O | O | O | O | O |
9+
| assert.equal | O | O | O | O | O |
10+
| assert.fail | O | O | O | O | O |
11+
| assert.notEqual | O | O | O | O | O |
12+
| assert.notStrictEqual | O | O | O | O | O |
13+
| assert.strictEqual | O | O | O | O | O |
14+
| assert.throws | O | O | O | O | O |
1515

1616
# Assert
1717

‎docs/api/IoT.js-API-BLE.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22

33
The following shows BLE module APIs available for each platform.
44

5-
| | Linux<br/>(Ubuntu) | Raspbian<br/>(Raspberry Pi) | NuttX<br/>(STM32F4-Discovery) | TizenRT<br/>(Artik053) |
6-
| :---: | :---: | :---: | :---: | :---: |
7-
| ble.startAdvertising | O | O | X | X |
8-
| ble.stopAdvertising | O | O | X | X |
9-
| ble.setServices | O | O | X | X |
5+
| | Linux<br/>(Ubuntu) | Tizen<br/>(Raspberry Pi) | Raspbian<br/>(Raspberry Pi) | NuttX<br/>(STM32F4-Discovery) | TizenRT<br/>(Artik053) |
6+
| :---: | :---: | :---: | :---: | :---: | :---: |
7+
| ble.startAdvertising | O | X | O | X | X |
8+
| ble.stopAdvertising | O | X | O | X | X |
9+
| ble.setServices | O | X | O | X | X |
1010

1111

1212
# BLE - Bluetooth Low Energy

‎docs/api/IoT.js-API-Buffer.md

+15-15
Original file line numberDiff line numberDiff line change
@@ -2,21 +2,21 @@
22

33
The following shows Buffer module APIs available for each platform.
44

5-
| | Linux<br/>(Ubuntu) | Raspbian<br/>(Raspberry Pi) | NuttX<br/>(STM32F4-Discovery) | TizenRT<br/>(Artik053) |
6-
| :---: | :---: | :---: | :---: | :---: |
7-
| buf.compare | O | O | O | O |
8-
| buf.copy | O | O | O | O |
9-
| buf.equals | O | O | O | O |
10-
| buf.fill | O | O | O | O |
11-
| buf.slice | O | O | O | O |
12-
| buf.toString | O | O | O | O |
13-
| buf.write | O | O | O | O |
14-
| buf.writeUInt8 | O | O | O | O |
15-
| buf.writeUInt16LE | O | O | O | O |
16-
| buf.writeUInt32LE | O | O | O | O |
17-
| buf.readInt8 | O | O | O | O |
18-
| buf.readUInt8 | O | O | O | O |
19-
| buf.readUInt16LE | O | O | O | O |
5+
| | Linux<br/>(Ubuntu) | Tizen<br/>(Raspberry Pi) | Raspbian<br/>(Raspberry Pi) | NuttX<br/>(STM32F4-Discovery) | TizenRT<br/>(Artik053) |
6+
| :---: | :---: | :---: | :---: | :---: | :---: |
7+
| buf.compare | O | O | O | O | O |
8+
| buf.copy | O | O | O | O | O |
9+
| buf.equals | O | O | O | O | O |
10+
| buf.fill | O | O | O | O | O |
11+
| buf.slice | O | O | O | O | O |
12+
| buf.toString | O | O | O | O | O |
13+
| buf.write | O | O | O | O | O |
14+
| buf.writeUInt8 | O | O | O | O | O |
15+
| buf.writeUInt16LE | O | O | O | O | O |
16+
| buf.writeUInt32LE | O | O | O | O | O |
17+
| buf.readInt8 | O | O | O | O | O |
18+
| buf.readUInt8 | O | O | O | O | O |
19+
| buf.readUInt16LE | O | O | O | O | O |
2020

2121

2222
# Buffer

‎docs/api/IoT.js-API-DGRAM.md

+13-13
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,19 @@
22

33
The following shows dgram module APIs available for each platform.
44

5-
| | Linux<br/>(Ubuntu) | Raspbian<br/>(Raspberry Pi) | NuttX<br/>(STM32F4-Discovery) | TizenRT<br/>(Artik053) |
6-
| :---: | :---: | :---: | :---: | :---: |
7-
| dgram.createSocket | O | O | △ ¹ | △ ¹ |
8-
| dgram.Socket.addMembership | O | O | X | O |
9-
| dgram.Socket.address | O | O | X | O |
10-
| dgram.Socket.bind | O | O | △ ¹ | △ ¹ |
11-
| dgram.Socket.close | O | O | △ ² | O |
12-
| dgram.Socket.dropMembership | O | O | X | O |
13-
| dgram.Socket.send | O | O | △ ¹ | △ ¹ |
14-
| dgram.Socket.setBroadcast | O | O | X | X |
15-
| dgram.Socket.setMulticastLoopback | O | O | X | O |
16-
| dgram.Socket.setMulticastTTL | X | X | X | O |
17-
| dgram.Socket.setTTL | O | O | X | O |
5+
| | Linux<br/>(Ubuntu) | Tizen<br/>(Raspberry Pi) | Raspbian<br/>(Raspberry Pi) | NuttX<br/>(STM32F4-Discovery) | TizenRT<br/>(Artik053) |
6+
| :---: | :---: | :---: | :---: | :---: | :---: |
7+
| dgram.createSocket | O | O | O | △ ¹ | △ ¹ |
8+
| dgram.Socket.addMembership | O | X | O | X | O |
9+
| dgram.Socket.address | O | O | O | X | O |
10+
| dgram.Socket.bind | O | O | O | △ ¹ | △ ¹ |
11+
| dgram.Socket.close | O | O | O | △ ² | O |
12+
| dgram.Socket.dropMembership | O | X | O | X | O |
13+
| dgram.Socket.send | O | O | O | △ ¹ | △ ¹ |
14+
| dgram.Socket.setBroadcast | O | X | O | X | X |
15+
| dgram.Socket.setMulticastLoopback | O | O | O | X | O |
16+
| dgram.Socket.setMulticastTTL | X | X | X | X | O |
17+
| dgram.Socket.setTTL | O | X | O | X | O |
1818

1919
1. On NuttX/STM32F4-Discovery and TizenRT/Artik053, even a couple of sockets/server/requests might not work properly.
2020

‎docs/api/IoT.js-API-DNS.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22

33
The following shows dns module APIs available for each platform.
44

5-
| | Linux<br/>(Ubuntu) | Raspbian<br/>(Raspberry Pi) | NuttX<br/>(STM32F4-Discovery) | TizenRT<br/>(Artik053) |
6-
| :---: | :---: | :---: | :---: | :---: |
7-
| dns.lookup | O | O | X | O |
5+
| | Linux<br/>(Ubuntu) | Tizen<br/>(Raspberry Pi) | Raspbian<br/>(Raspberry Pi) | NuttX<br/>(STM32F4-Discovery) | TizenRT<br/>(Artik053) |
6+
| :---: | :---: | :---: | :---: | :---: | :---: |
7+
| dns.lookup | O | O | O | X | O |
88

99
※ dns.lookup currently only returns IPv4 addresses. Support for IPv6 addresses are on the roadmap.
1010

‎docs/api/IoT.js-API-Events.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,14 @@
22

33
The following shows Event module APIs available for each platform.
44

5-
| | Linux<br/>(Ubuntu) | Raspbian<br/>(Raspberry Pi) | NuttX<br/>(STM32F4-Discovery) | TizenRT<br/>(Artik053) |
6-
| :---: | :---: | :---: | :---: | :---: |
7-
| emitter.addListener | O | O | O | O |
8-
| emitter.on | O | O | O | O |
9-
| emitter.emit | O | O | O | O |
10-
| emitter.once | O | O | O | O |
11-
| emitter.removeListener | O | O | O | O |
12-
| emitter.removeAllListeners | O | O | O | O |
5+
| | Linux<br/>(Ubuntu) | Tizen<br/>(Raspberry Pi) | Raspbian<br/>(Raspberry Pi) | NuttX<br/>(STM32F4-Discovery) | TizenRT<br/>(Artik053) |
6+
| :---: | :---: | :---: | :---: | :---: | :---: |
7+
| emitter.addListener | O | O | O | O | O |
8+
| emitter.on | O | O | O | O | O |
9+
| emitter.emit | O | O | O | O | O |
10+
| emitter.once | O | O | O | O | O |
11+
| emitter.removeListener | O | O | O | O | O |
12+
| emitter.removeAllListeners | O | O | O | O | O |
1313

1414

1515
# Events

‎docs/api/IoT.js-API-File-System.md

+30-30
Original file line numberDiff line numberDiff line change
@@ -2,36 +2,36 @@
22

33
The following shows fs module APIs available for each platform.
44

5-
| | Linux<br/>(Ubuntu) | Raspbian<br/>(Raspberry Pi) | NuttX<br/>(STM32F4-Discovery) | TizenRT<br/>(Artik053) |
6-
| :---: | :---: | :---: | :---: | :---: |
7-
| fs.close | O | O | O | O |
8-
| fs.closeSync | O | O | O | O |
9-
| fs.exists | O | O | O | O |
10-
| fs.existsSync | O | O | O | O |
11-
| fs.fstat | O | O | X | X |
12-
| fs.fstatSync | O | O | X | X |
13-
| fs.mkdir | O | O | O | O |
14-
| fs.mkdirSync | O | O | O | O |
15-
| fs.open | O | O | O | O |
16-
| fs.openSync | O | O | O | O |
17-
| fs.read | O | O | O | O |
18-
| fs.readSync | O | O | O | O |
19-
| fs.readdir | O | O | O | O |
20-
| fs.readdirSync | O | O | O | O |
21-
| fs.readFile | O | O | O | O |
22-
| fs.readFileSync | O | O | O | O |
23-
| fs.rename | O | O | O | O |
24-
| fs.renameSync | O | O | O | O |
25-
| fs.rmdir | O | O | O | O |
26-
| fs.rmdirSync | O | O | O | O |
27-
| fs.stat | O | O | O | O |
28-
| fs.statSync | O | O | O | O |
29-
| fs.unlink | O | O | O | O |
30-
| fs.unlinkSync | O | O | O | O |
31-
| fs.write | O | O | O | O |
32-
| fs.writeSync | O | O | O | O |
33-
| fs.writeFile | O | O | O | O |
34-
| fs.writeFileSync | O | O | O | O |
5+
| | Linux<br/>(Ubuntu) | Tizen<br/>(Raspberry Pi) | Raspbian<br/>(Raspberry Pi) | NuttX<br/>(STM32F4-Discovery) | TizenRT<br/>(Artik053) |
6+
| :---: | :---: | :---: | :---: | :---: | :---: |
7+
| fs.close | O | O | O | O | O |
8+
| fs.closeSync | O | O | O | O | O |
9+
| fs.exists | O | O | O | O | O |
10+
| fs.existsSync | O | O | O | O | O |
11+
| fs.fstat | O | O | O | X | X |
12+
| fs.fstatSync | O | O | O | X | X |
13+
| fs.mkdir | O | O | O | O | O |
14+
| fs.mkdirSync | O | O | O | O | O |
15+
| fs.open | O | O | O | O | O |
16+
| fs.openSync | O | O | O | O | O |
17+
| fs.read | O | O | O | O | O |
18+
| fs.readSync | O | O | O | O | O |
19+
| fs.readdir | O | O | O | O | O |
20+
| fs.readdirSync | O | O | O | O | O |
21+
| fs.readFile | O | O | O | O | O |
22+
| fs.readFileSync | O | O | O | O | O |
23+
| fs.rename | O | O | O | O | O |
24+
| fs.renameSync | O | O | O | O | O |
25+
| fs.rmdir | O | O | O | O | O |
26+
| fs.rmdirSync | O | O | O | O | O |
27+
| fs.stat | O | O | O | O | O |
28+
| fs.statSync | O | O | O | O | O |
29+
| fs.unlink | O | O | O | O | O |
30+
| fs.unlinkSync | O | O | O | O | O |
31+
| fs.write | O | O | O | O | O |
32+
| fs.writeSync | O | O | O | O | O |
33+
| fs.writeFile | O | O | O | O | O |
34+
| fs.writeFileSync | O | O | O | O | O |
3535

3636
※ On NuttX path should be passed with a form of **absolute path**.
3737

‎docs/api/IoT.js-API-GPIO.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,16 @@
22

33
The following shows GPIO module APIs available for each platform.
44

5-
| | Linux<br/>(Ubuntu) | Raspbian<br/>(Raspberry Pi) | NuttX<br/>(STM32F4-Discovery) | TizenRT<br/>(Artik053) |
6-
| :---: | :---: | :---: | :---: | :---: |
7-
| gpio.open | O | O | O | O |
8-
| gpio.openSync | O | O | O | O |
9-
| gpiopin.write | O | O | O | O |
10-
| gpiopin.writeSync | O | O | O | O |
11-
| gpiopin.read | △ | △ | O | O |
12-
| gpiopin.readSync | O | O | O | O |
13-
| gpiopin.close | O | O | O | O |
14-
| gpiopin.closeSync | O | O | O | O |
5+
| | Linux<br/>(Ubuntu) | Tizen<br/>(Raspberry Pi) | Raspbian<br/>(Raspberry Pi) | NuttX<br/>(STM32F4-Discovery) | TizenRT<br/>(Artik053) |
6+
| :---: | :---: | :---: | :---: | :---: | :---: |
7+
| gpio.open | X | O | O | O | O |
8+
| gpio.openSync | X | O | O | O | O |
9+
| gpiopin.write | X | O | O | O | O |
10+
| gpiopin.writeSync | X | O | O | O | O |
11+
| gpiopin.read | X | O | △ | O | O |
12+
| gpiopin.readSync | X | O | O | O | O |
13+
| gpiopin.close | X | O | O | O | O |
14+
| gpiopin.closeSync | X | O | O | O | O |
1515

1616

1717
# GPIO

‎docs/api/IoT.js-API-HTTP.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22

33
The following shows Http module APIs available for each platform.
44

5-
| | Linux<br/>(Ubuntu) | Raspbian<br/>(Raspberry Pi) | NuttX<br/>(STM32F4-Discovery) | TizenRT<br/>(Artik053) |
6-
| :---: | :---: | :---: | :---: | :---: |
7-
| http.createServer | O | O | △ ¹ | △ ¹ |
8-
| http.request | O | O | △ ¹ | △ ¹ |
9-
| http.get | O | O | △ ¹ | △ ¹ |
5+
| | Linux<br/>(Ubuntu) | Tizen<br/>(Raspberry Pi) | Raspbian<br/>(Raspberry Pi) | NuttX<br/>(STM32F4-Discovery) | TizenRT<br/>(Artik053) |
6+
| :---: | :---: | :---: | :---: | :---: | :---: |
7+
| http.createServer | O | O | O | △ ¹ | △ ¹ |
8+
| http.request | O | O | O | △ ¹ | △ ¹ |
9+
| http.get | O | O | O | △ ¹ | △ ¹ |
1010

1111
1. On NuttX/STM32F4-Discovery and TizenRT/Artik053, even a couple of sockets/server/requests might not work properly.
1212

‎docs/api/IoT.js-API-HTTPS.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22

33
The following shows Https module APIs available for each platform.
44

5-
| | Linux<br/>(Ubuntu) | Raspbian<br/>(Raspberry Pi) | NuttX<br/>(STM32F4-Discovery) | TizenRT<br/>(Artik053) |
6-
| :---: | :---: | :---: | :---: | :---: |
7-
| https.createServer | O | O | △ ¹ | △ ¹ |
8-
| https.request | O | O | △ ¹ | △ ¹ |
9-
| https.get | O | O | △ ¹ | △ ¹ |
5+
| | Linux<br/>(Ubuntu) | Tizen<br/>(Raspberry Pi) | Raspbian<br/>(Raspberry Pi) | NuttX<br/>(STM32F4-Discovery) | TizenRT<br/>(Artik053) |
6+
| :---: | :---: | :---: | :---: | :---: | :---: |
7+
| https.createServer | O | O | O | △ ¹ | △ ¹ |
8+
| https.request | O | O | O | △ ¹ | △ ¹ |
9+
| https.get | O | O | O | △ ¹ | △ ¹ |
1010

1111
1. On NuttX/STM32F4-Discovery and TizenRT/Artik053, even a couple of sockets/server/requests might not work properly.
1212

‎docs/api/IoT.js-API-I2C.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,14 @@ The following shows I2C module APIs available for each platform.
44

55
| | Linux<br/>(Ubuntu) | Tizen<br/>(Raspberry Pi) | Raspbian<br/>(Raspberry Pi) | NuttX<br/>(STM32F4-Discovery) | TizenRT<br/>(Artik053) |
66
| :---: | :---: | :---: | :---: | :---: | :---: |
7-
| i2c.open | O | O | O | O | O |
8-
| i2c.openSync | O | O | O | O | O |
9-
| i2cbus.read | O | O | O | O | O |
10-
| i2cbus.readSync | O | O | O | O | O |
11-
| i2cbus.write | O | O | O | O | O |
12-
| i2cbus.writeSync | O | O | O | O | O |
13-
| i2cbus.close | O | O | O | O | O |
14-
| i2cbus.closeSync | O | O | O | O | O |
7+
| i2c.open | X | O | O | O | O |
8+
| i2c.openSync | X | O | O | O | O |
9+
| i2cbus.read | X | O | O | O | O |
10+
| i2cbus.readSync | X | O | O | O | O |
11+
| i2cbus.write | X | O | O | O | O |
12+
| i2cbus.writeSync | X | O | O | O | O |
13+
| i2cbus.close | X | O | O | O | O |
14+
| i2cbus.closeSync | X | O | O | O | O |
1515

1616

1717
# I2C

‎docs/api/IoT.js-API-Module.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22

33
The following shows module APIs available for each platform.
44

5-
| | Linux<br/>(Ubuntu) | Raspbian<br/>(Raspberry Pi) | NuttX<br/>(STM32F4-Discovery) | TizenRT<br/>(Artik053) |
6-
| :---: | :---: | :---: | :---: | :---: |
7-
| require | O | O | O | O |
5+
| | Linux<br/>(Ubuntu) | Tizen<br/>(Raspberry Pi) | Raspbian<br/>(Raspberry Pi) | NuttX<br/>(STM32F4-Discovery) | TizenRT<br/>(Artik053) |
6+
| :---: | :---: | :---: | :---: | :---: | :---: |
7+
| require | O | O | O | O | O |
88

99
# Module
1010
The `require` function is always available there is no need to import `module` explicitly.

0 commit comments

Comments
 (0)