diff --git a/README.md b/README.md
index 0f7a7f3..3be4813 100644
--- a/README.md
+++ b/README.md
@@ -25,7 +25,8 @@ npm install --save freeathome-local-api-client
## Documentation
-A sample project illustrating the use of the library can be found at https://github.com/pgerke/freeathome-local-api-sample.
+The client library is documented using JSDoc, the generated documentation is available at https://pgerke.github.io/freeathome-local-api-client/.
+There is also a sample project illustrating the use of the library can be found at https://github.com/pgerke/freeathome-local-api-sample.
## I found a bug, what do I do?
diff --git a/docs/Channel.html b/docs/Channel.html
index 7b38ac3..25be047 100644
--- a/docs/Channel.html
+++ b/docs/Channel.html
@@ -40,6 +40,10 @@
@@ -64,6 +77,10 @@
id="sidebarNav"
>
+
+
+
+
@@ -94,7 +111,7 @@ Channel
-
Describes a device channel
+
Describes a device channel
@@ -159,38 +176,704 @@
Channel
+
+
Members
+
+
+
+
+
+ Type:
+
+string
+
+
+
+
+
+ #
+
+
+ displayName
+
+
+ Optional
+
+
+
+
+
+
+
+
The channel display name.
+
+
+
+
+
+
+
+
+
-
-
+
+
+
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ View Source
+
+ model/channel.ts , line 8
+
+
+
+
+
+
+
+
+
+
-
+
+
+
+ Type:
+
+string
+
+
+
+
+
+ #
+
+
+ floor
+
+
+ Optional
+
+
+
+
+
+
+
+
The floor to which the channel is mapped.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ View Source
+
+ model/channel.ts , line 23
+
+
+
+
+
+
+
+
+
+
-
-
-
-
-
-
-
+
+
+
+ Type:
+
+string
+
+
+
+
+
+ #
+
+
+ functionID
+
+
+ Optional
+
+
+
+
+
+
+
+
The function identifier.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ View Source
+
+ model/channel.ts , line 13
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Type:
+
+object
+
+
+
+
+
+
+
+
+
+
+
The inputs provided by the channel.
+
+
+
+
+
+
+
Properties:
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ {...}
+
+
+
+
+
+InOutPut
+
+
+
+
+
+
+
+
+
+ The input identified by a string key.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ View Source
+
+ model/channel.ts , line 28
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Type:
+
+object
+
+
+
+
+
+ #
+
+
+ outputs
+
+
+ Optional
+
+
+
+
+
+
+
+
The output provided by the channel.
+
+
+
+
+
+
+
Properties:
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ {...}
+
+
+
+
+
+InOutPut
+
+
+
+
+
+
+
+
+
+ The output identified by a string key.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ View Source
+
+ model/channel.ts , line 34
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Type:
+
+string
+
+
+
+
+
+ #
+
+
+ room
+
+
+ Optional
+
+
+
+
+
+
+
+
The room to which the channel is mapped.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ View Source
+
+ model/channel.ts , line 18
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Type:
+
+string
+
+
+
+
+
+ #
+
+
+ type
+
+
+ Optional
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ View Source
+
+ model/channel.ts , line 40
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+