@sixfathoms/lplex 0.2.0 → 0.2.1

package/README.md

@@ -58,7 +58,7 @@ for (const d of devices) {
 }
 ```
 
-### `client.values(signal?): Promise<DeviceValues[]>`
+### `client.values(filter?, signal?): Promise<DeviceValues[]>`
 
 Returns the last-seen value for each (device, PGN) pair, grouped by device. Useful for getting a snapshot of current bus state without subscribing to SSE.
 
@@ -72,6 +72,15 @@ for (const device of snapshot) {
 }
 ```
 
+Pass a `Filter` to narrow results by PGN and/or device criteria:
+
+```typescript
+const positions = await client.values({
+  pgn: [129025],
+  manufacturer: ["Garmin"],
+});
+```
+
 ### `client.subscribe(filter?, signal?): Promise<AsyncIterable<Event>>`
 
 Opens an ephemeral SSE stream. No session state, no replay. Frames flow until you stop reading or abort.
@@ -326,7 +335,7 @@ interface DeviceValues {
 | `/clients/{id}/ack` | PUT | ACK sequence number. JSON body: `{ "seq": N }`. Returns 204. |
 | `/send` | POST | Transmit CAN frame. JSON body: `pgn`, `src`, `dst`, `prio`, `data`. Returns 202. |
 | `/devices` | GET | Device snapshot. Returns JSON array. |
-| `/values` | GET | Last-seen value per (device, PGN). Returns JSON array grouped by device. |
+| `/values` | GET | Last-seen value per (device, PGN). Query params: `pgn`, `manufacturer`, `instance`, `name` (repeatable). Returns JSON array grouped by device. |
 
 ## License
 

package/dist/index.cjs

@@ -171,8 +171,10 @@ var Client = class {
     return resp.json();
   }
   /** Fetch the last-seen value for each (device, PGN) pair. */
-  async values(signal) {
-    const url = `${this.#baseURL}/values`;
+  async values(filter, signal) {
+    let url = `${this.#baseURL}/values`;
+    const qs = filterToQueryString(filter);
+    if (qs) url += `?${qs}`;
     const resp = await this.#fetch(url, { signal });
     if (!resp.ok) {
       const body = await resp.text();

package/dist/index.d.cts

@@ -143,7 +143,7 @@ declare class Client {
     /** Fetch a snapshot of all NMEA 2000 devices discovered by the server. */
     devices(signal?: AbortSignal): Promise<Device[]>;
     /** Fetch the last-seen value for each (device, PGN) pair. */
-    values(signal?: AbortSignal): Promise<DeviceValues[]>;
+    values(filter?: Filter, signal?: AbortSignal): Promise<DeviceValues[]>;
     /**
      * Open an ephemeral SSE stream with optional filtering.
      * No session, no replay, no ACK.

package/dist/index.d.ts

@@ -143,7 +143,7 @@ declare class Client {
     /** Fetch a snapshot of all NMEA 2000 devices discovered by the server. */
     devices(signal?: AbortSignal): Promise<Device[]>;
     /** Fetch the last-seen value for each (device, PGN) pair. */
-    values(signal?: AbortSignal): Promise<DeviceValues[]>;
+    values(filter?: Filter, signal?: AbortSignal): Promise<DeviceValues[]>;
     /**
      * Open an ephemeral SSE stream with optional filtering.
      * No session, no replay, no ACK.

package/dist/index.js

@@ -141,8 +141,10 @@ var Client = class {
     return resp.json();
   }
   /** Fetch the last-seen value for each (device, PGN) pair. */
-  async values(signal) {
-    const url = `${this.#baseURL}/values`;
+  async values(filter, signal) {
+    let url = `${this.#baseURL}/values`;
+    const qs = filterToQueryString(filter);
+    if (qs) url += `?${qs}`;
     const resp = await this.#fetch(url, { signal });
     if (!resp.ok) {
       const body = await resp.text();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sixfathoms/lplex",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "description": "TypeScript client for lplex CAN bus HTTP bridge",
   "type": "module",
   "main": "./dist/index.cjs",