Skip to content

Commit 14280c8

Browse files
fh1chfh1ch
authored
Merge pull request #166 from fh1ch/docs/client-function-jsdocs-coverage
Docs/client function jsdocs coverage
2 parents 88dc8cc + 149f90e commit 14280c8

2 files changed

Lines changed: 252 additions & 20 deletions

File tree

‎README.md‎

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ The API documentation is available under **[fh1ch.github.io/node-bacstack](https
2121

2222
### Features
2323

24-
The BACNET standard defines a wide variety of services as part of it's
24+
The BACnet standard defines a wide variety of services as part of it's
2525
specification. While Node BACstack tries to be as complete as possible,
2626
following services are already supported at this point in time:
2727

@@ -35,29 +35,30 @@ following services are already supported at this point in time:
3535
| UTC Time Sync | [yes](https://fh1ch.github.io/node-bacstack/bacstack.html#.timeSyncUTC) | [yes](https://fh1ch.github.io/node-bacstack/bacstack.html#.event:timeSyncUTC) |
3636
| Read Property | [yes](https://fh1ch.github.io/node-bacstack/bacstack.html#.readProperty) | yes¹ |
3737
| Read Property Multiple | [yes](https://fh1ch.github.io/node-bacstack/bacstack.html#.readPropertyMultiple) | yes¹ |
38-
| Read Range | yes¹ | yes¹ |
38+
| Read Range | [yes](https://fh1ch.github.io/node-bacstack/bacstack.html#.readRange) | yes¹ |
3939
| Write Property | [yes](https://fh1ch.github.io/node-bacstack/bacstack.html#.writeProperty) | yes¹ |
4040
| Write Property Multiple | [yes](https://fh1ch.github.io/node-bacstack/bacstack.html#.writePropertyMultiple) | yes¹ |
4141
| Add List Element | yes¹ | yes¹ |
4242
| Remove List Element | yes¹ | yes¹ |
4343
| Create Object | yes¹ | yes¹ |
44-
| Delete Object | yes¹ | yes¹ |
45-
| Subscribe COV | yes¹ | yes¹ |
46-
| Subscribe Property | yes¹ | yes¹ |
47-
| Atomic Read File | yes¹ | yes¹ |
48-
| Atomic Write File | yes¹ | yes¹ |
44+
| Delete Object | [yes](https://fh1ch.github.io/node-bacstack/bacstack.html#.deleteObject) | yes¹ |
45+
| Subscribe COV | [yes](https://fh1ch.github.io/node-bacstack/bacstack.html#.subscribeCOV) | yes¹ |
46+
| Subscribe Property | [yes](https://fh1ch.github.io/node-bacstack/bacstack.html#.subscribeProperty) | yes¹ |
47+
| Atomic Read File | [yes](https://fh1ch.github.io/node-bacstack/bacstack.html#.readFile) | yes¹ |
48+
| Atomic Write File | [yes](https://fh1ch.github.io/node-bacstack/bacstack.html#.writeFile) | yes¹ |
4949
| Reinitialize Device | [yes](https://fh1ch.github.io/node-bacstack/bacstack.html#.reinitializeDevice) | yes¹ |
5050
| Device Communication Control | [yes](https://fh1ch.github.io/node-bacstack/bacstack.html#.deviceCommunicationControl) | yes¹ |
51-
| Get Alarm Summary | yes¹ | yes¹ |
52-
| Get Event Information | yes¹ | yes¹ |
53-
| Get Enrollment Summary | yes¹ | yes¹ |
51+
| Get Alarm Summary² | [yes](https://fh1ch.github.io/node-bacstack/bacstack.html#.getAlarmSummary) | yes¹ |
52+
| Get Event Information | [yes](https://fh1ch.github.io/node-bacstack/bacstack.html#.getEventInformation) | yes¹ |
53+
| Get Enrollment Summary² | [yes](https://fh1ch.github.io/node-bacstack/bacstack.html#.getEnrollmentSummary) | yes¹ |
5454
| Acknowledge Alarm | yes¹ | yes¹ |
5555
| Confirmed Event Notification | yes¹ | yes¹ |
5656
| Unconfirmed Event Notification | yes¹ | yes¹ |
57-
| Unconfirmed Private Transfer | yes¹ | yes¹ |
58-
| Confirmed Private Transfer | yes¹ | yes¹ |
57+
| Unconfirmed Private Transfer | [yes](https://fh1ch.github.io/node-bacstack/bacstack.html#.unconfirmedPrivateTransfer) | yes¹ |
58+
| Confirmed Private Transfer | [yes](https://fh1ch.github.io/node-bacstack/bacstack.html#.confirmedPrivateTransfer) | yes¹ |
5959

6060
¹ Support implemented as Beta (untested, undocumented, breaking interface)
61+
² Deprecated BACnet function, available for backwards compatibility
6162

6263
### Example
6364

0 commit comments

Comments
 (0)