updated smplaes

Author: pelikhan

README.md

@@ -7,12 +7,50 @@ This library uses the [serial-to-i2c bridge](// https://dev.blues.io/guides-and-
 
 ** This library has a minimal surface and most messages have not been mapped to types. See [Notecard API](https://dev.blues.io/api-reference/notecard-api/introduction/) for a full list. **
 
-## Usage
+## Setup
 
-Add the library to your project:
+Add the library to your DeviceScript project:
 
 ```bash
 npm install --save pelikhan/devicescript-note
 ```
 
-## [Contributing](./CONTRIBUTING.md)
+## Configuration
+
+Add the notehub product UID into your settings.
+
+```yaml
+# .env.defaults
+NOTE_PUID=your-product-uid
+```
+
+By default, DeviceScript will use the deviceid as a serial number; but you can override this setting.
+
+```yaml
+# .env.defaults
+NOTE_PUID=your-product-uid
+NOTE_SN=your-serial-number
+```
+
+## Usage
+
+-   Connect the notecard to your I2C pins and power it up.
+-   Start by calling `init` for the initial handshake with the notecard.
+
+```ts
+import { delay, millis } from "@devicescript/core"
+import { init, request } from "devicescript-note"
+
+// configure product UID and serial number
+await init()
+
+while (true) {
+    // send node.add request
+    const res = await request({ req: "note.add", body: { time: millis() } })
+    console.log(res)
+    // take a break
+    await delay(10000)
+}
+```
+
+## [Contributing](./CONTRIBUTING.md)

src/index.ts

@@ -4,7 +4,7 @@ import { I2CError, i2c } from "@devicescript/i2c"
 import { readSetting } from "@devicescript/settings"
 
 function debug(msg: string) {
-    console.debug(`notes> ` + msg)
+    //console.debug(`notes> ` + msg)
 }
 
 /**

src/main.ts

@@ -1,18 +1,13 @@
-import { pins, board } from "@dsboard/adafruit_qt_py_c3"
-import { delay } from "@devicescript/core"
-import { HubLogRequest, NoteAddRequest, init, request } from "."
+import { delay, millis } from "@devicescript/core"
+import { init, request } from "."
 
-await init({ mode: "continuous", sync: true })
+// configure product UID and serial number
+await init()
 
-let i = 0
 while (true) {
-    await delay(5000)
-    await request<HubLogRequest>({ req: "hub.log", text: "counter: " + i })
-    await request(<NoteAddRequest>{
-        req: "note.add",
-        body: {
-            i,
-        },
-    })
-    console.log(await request({ req: "hub.status" }))
+    // send node.add request
+    const res = await request({ req: "note.add", body: { time: millis() } })
+    console.log(res)
+    // take a break
+    await delay(10000)
 }