Skip to content

Commit fc0ac2d

Browse files
committed
Just added 0.0.1b version info, and demo command
1 parent 9009c67 commit fc0ac2d

3 files changed

Lines changed: 62 additions & 2276 deletions

File tree

README.md

Lines changed: 43 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,44 @@
11
# z21
2-
A Z21 client library
2+
A Z21 client library made with Nodejs & Typescript to connect via http / udp protocols with the connected device(s).
3+
4+
<br />
5+
6+
## How does it works?
7+
8+
In this version only two ts files are included:
9+
10+
* ***src/z21Client.ts:*** this is the main Z21 udp client, only the <code>*public sendRequest(command: Buffer): Promise<Buffer>*</code> function is supported by the now
11+
* ***src/app.ts:*** this is the main app file, just gets the Z21 serial number
12+
13+
<br />
14+
15+
## Test this version
16+
17+
On this version you can simply use the ***app.ts*** module that uses the ***z21Client.ts***.
18+
19+
Launch the demo app with:
20+
21+
$ npm run demo
22+
23+
and see what's happend...
24+
25+
26+
<br />
27+
28+
## Next steps
29+
30+
Work is in progres...
31+
32+
Any contribution will be welcome :-)
33+
34+
35+
<br />
36+
37+
---
38+
39+
<br />
40+
41+
## Revisions
42+
43+
* **0.0.1b (2022-02-01)**
44+
> First version of the library. Project is started, including a very very simple udp socket client that connects with the Z21 device and accepts http requests. Also a very very simple app that uses this client is included.

0 commit comments

Comments
 (0)