Skip to content
This repository was archived by the owner on Aug 5, 2022. It is now read-only.

Commit 3526a34

Browse files
authored
Merge pull request #38 from zolkis/reorg
Reorganise repository.
2 parents 0724928 + d25677e commit 3526a34

File tree

79 files changed

+546
-482
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

79 files changed

+546
-482
lines changed

README.md

Lines changed: 81 additions & 187 deletions
Large diffs are not rendered by default.

api/README.md

Lines changed: 0 additions & 84 deletions
This file was deleted.

api/eventobserver.md

Lines changed: 0 additions & 177 deletions
This file was deleted.

api/ble/README.md renamed to ble/README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,7 @@ This object is created and returned by `require`. It has the following read-only
4646
| `name` | String | yes | `undefined` | the Bluetooth Device Name in scan responses |
4747
| `enabled` | boolean | no | false | whether Bluetooth is enabled |
4848
| `services` | array of [service objects](#service) | no | [] | Primary services on the device |
49+
| `version` | string | no | `version` in[`package.json`](../package.json) | API version |
4950

5051
| Event name | Event callback argument |
5152
| --- | --- |
@@ -80,6 +81,9 @@ The `enabled` property MUST be set to `true` if the Bluetooth Smart functionalit
8081
<a name="bd_services">
8182
The `services` property is a read-only array (sequence) of [`BluetoothService`](#service) objects that represents the primary GATT services on the device. A primary service is visible at device root level, and it may contain other services.
8283

84+
<a name="version"></a>
85+
The `version` property is read-only, and provides the master API version, as specified in the `version` property of [`package.json`](../package.json).
86+
8387
#### `BluetoothPeripheralDevice` events
8488

8589
<a name="onstatechange"></a>
File renamed without changes.

api/board/README.md renamed to board/README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,7 @@ Represents a hardware board.
5555
| Property | Type | Optional | Default value | Represents |
5656
| --- | --- | --- | --- | --- |
5757
| [`name`](#name) | String | no | `undefined` | board name |
58+
| [`version`](#version) | String | no | `versions.board` in [`package.json`](../package.json) | API version |
5859

5960
| Method signature | Description |
6061
| --- | --- |
@@ -72,6 +73,9 @@ Represents a hardware board.
7273
<a name="name"></a>
7374
The `name` property is read-only, and provides the board name.
7475

76+
<a name="version"></a>
77+
The `version` property is read-only, and provides the provides the Board API version, as specified in the `versions.board` property of [`package.json`](../package.json).
78+
7579
<a name="error"></a>
7680
Board errors are represented as augmented [`Error`](https://nodejs.org/api/errors.html#errors_class_error) objects. The following [`Error` names](https://nodejs.org/api/errors.html) are used for signaling issues:
7781
- `BoardDisconnectError`
File renamed without changes.

api/board/arduino101.md renamed to board/arduino101.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,6 @@ Arduino 101 pins are summarized in the following table (channel means the index
5151
| `"A3"` | ANALOG_IN(3) |
5252
| `"A4"` | ANALOG_IN(4) |
5353
| `"A5"` | ANALOG_IN(5) |
54-
| `"LED0"` | active on 1 |
55-
| `"LED1"` | active on 0 |
56-
| `"LED2"` | active on 0 |
54+
| `"LED0"` | alias for GPIO connected LED, active on 1 |
55+
| `"LED1"` | alias for GPIO connected LED, active on 0 |
56+
| `"LED2"` | alias for GPIO connected LED, active on 0 |
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)