@science-corporation/synapse 0.9.0 → 0.10.0

package/src/api/proto.json

@@ -24,6 +24,10 @@
             "highCutoffHz": {
               "type": "float",
               "id": 3
+            },
+            "sampleRateHz": {
+              "type": "float",
+              "id": 4
             }
           }
         },
@@ -52,6 +56,14 @@
             }
           }
         },
+        "ElectricalStimulationStatus": {
+          "fields": {
+            "lsbUV": {
+              "type": "float",
+              "id": 1
+            }
+          }
+        },
         "Channel": {
           "fields": {
             "id": {
@@ -101,6 +113,14 @@
             }
           }
         },
+        "ElectricalBroadbandStatus": {
+          "fields": {
+            "lsbUV": {
+              "type": "float",
+              "id": 1
+            }
+          }
+        },
         "SpikeDetectConfig": {
           "fields": {
             "mode": {
@@ -140,6 +160,19 @@
             "dataType": {
               "type": "DataType",
               "id": 1
+            },
+            "shape": {
+              "rule": "repeated",
+              "type": "uint32",
+              "id": 2
+            }
+          }
+        },
+        "StreamInStatus": {
+          "fields": {
+            "throughputMbps": {
+              "type": "float",
+              "id": 1
             }
           }
         },
@@ -153,6 +186,14 @@
             "kImage": 5
           }
         },
+        "DiskWriterConfig": {
+          "fields": {
+            "filename": {
+              "type": "string",
+              "id": 1
+            }
+          }
+        },
         "StreamOutConfig": {
           "fields": {
             "label": {
@@ -165,6 +206,14 @@
             }
           }
         },
+        "StreamOutStatus": {
+          "fields": {
+            "throughputMbps": {
+              "type": "float",
+              "id": 1
+            }
+          }
+        },
         "OpticalBroadbandConfig": {
           "fields": {
             "peripheralId": {
@@ -232,6 +281,10 @@
             "type": {
               "type": "Type",
               "id": 4
+            },
+            "address": {
+              "type": "string",
+              "id": 5
             }
           },
           "nested": {
@@ -344,7 +397,8 @@
             "kOpticalBroadband": 5,
             "kOpticalStimulation": 6,
             "kSpikeDetect": 7,
-            "kSpectralFilter": 8
+            "kSpectralFilter": 8,
+            "kDiskWriter": 9
           }
         },
         "NodeConfig": {
@@ -358,7 +412,8 @@
                 "opticalBroadband",
                 "opticalStimulation",
                 "spikeDetect",
-                "spectralFilter"
+                "spectralFilter",
+                "diskWriter"
               ]
             }
           },
@@ -402,6 +457,48 @@
             "spectralFilter": {
               "type": "SpectralFilterConfig",
               "id": 10
+            },
+            "diskWriter": {
+              "type": "DiskWriterConfig",
+              "id": 11
+            }
+          }
+        },
+        "NodeStatus": {
+          "oneofs": {
+            "status": {
+              "oneof": [
+                "streamOut",
+                "electricalBroadband",
+                "streamIn",
+                "electricalStimulation"
+              ]
+            }
+          },
+          "fields": {
+            "type": {
+              "type": "NodeType",
+              "id": 1
+            },
+            "id": {
+              "type": "uint32",
+              "id": 2
+            },
+            "streamOut": {
+              "type": "StreamOutStatus",
+              "id": 3
+            },
+            "electricalBroadband": {
+              "type": "ElectricalBroadbandStatus",
+              "id": 4
+            },
+            "streamIn": {
+              "type": "StreamInStatus",
+              "id": 5
+            },
+            "electricalStimulation": {
+              "type": "ElectricalStimulationStatus",
+              "id": 6
             }
           }
         },
@@ -558,7 +655,8 @@
             "kFailedPrecondition": 3,
             "kUnimplemented": 4,
             "kInternalError": 5,
-            "kPermissionDenied": 6
+            "kPermissionDenied": 6,
+            "kQueryFailed": 7
           }
         },
         "DeviceState": {
@@ -594,6 +692,15 @@
             }
           }
         },
+        "SignalChainStatus": {
+          "fields": {
+            "nodes": {
+              "rule": "repeated",
+              "type": "NodeStatus",
+              "id": 1
+            }
+          }
+        },
         "Status": {
           "fields": {
             "message": {
@@ -620,6 +727,10 @@
             "storage": {
               "type": "DeviceStorage",
               "id": 6
+            },
+            "signalChain": {
+              "type": "SignalChainStatus",
+              "id": 7
             }
           }
         },

package/src/device.ts

@@ -5,6 +5,10 @@ import Config from "./config";
 import { create } from "./utils/client";
 import { getName } from "./utils/enum";
 
+export interface CallOptions {
+  deadline?: Date;
+}
+
 class Device {
   rpc: any | null = null;
   channel: Channel | null = null;
@@ -17,12 +21,11 @@ class Device {
     }
   }
 
-  async configure(config: Config): Promise<boolean> {
+  async configure(config: Config, options: CallOptions = {}): Promise<boolean> {
     return new Promise((resolve, reject) => {
       config.setDevice(this);
-
       const proto = config.toProto();
-      this.rpc.configure(proto, (err, res) => {
+      this.rpc.configure(proto, options, (err, res) => {
         if (err) {
           reject(err);
         } else {
@@ -36,21 +39,25 @@ class Device {
     });
   }
 
-  async info(): Promise<synapse.DeviceInfo> {
+  async info(options: CallOptions = {}): Promise<synapse.DeviceInfo> {
     return new Promise((resolve, reject) => {
-      this.rpc.info({}, (err, res) => {
+      this.rpc.info({}, options, (err, res) => {
         if (err) {
           reject(err);
         } else {
-          resolve(res!);
+          if (this._handleStatusResponse(res.status)) {
+            resolve(res!);
+          } else {
+            reject(`Error starting device: (code: ${getName(synapse.StatusCode, res.code)}) ${res.message}`);
+          }
         }
       });
     });
   }
 
-  async start(): Promise<boolean> {
+  async start(options: CallOptions = {}): Promise<boolean> {
     return new Promise((resolve, reject) => {
-      this.rpc.start({}, (err, res) => {
+      this.rpc.start({}, options, (err, res) => {
         if (err) {
           reject(err);
         } else {
@@ -64,9 +71,9 @@ class Device {
     });
   }
 
-  async stop(): Promise<boolean> {
+  async stop(options: CallOptions = {}): Promise<boolean> {
     return new Promise((resolve, reject) => {
-      this.rpc.stop({}, (err, res) => {
+      this.rpc.stop({}, options, (err, res) => {
         if (err) {
           reject(err);
         } else {

package/src/index.ts

@@ -1,4 +1,4 @@
 export { default as Config } from "./config";
-export { default as Device } from "./device";
+export { default as Device, CallOptions } from "./device";
 export * from "./nodes";
 export { synapse } from "./api/api";

package/src/nodes/stream_in.ts

@@ -3,11 +3,6 @@ import dgram from "dgram";
 import { synapse } from "../api/api";
 import Node from "../node";
 
-export interface StreamInArgs {
-  dataType: synapse.DataType;
-  shape?: number[];
-}
-
 class StreamIn extends Node {
   type = synapse.NodeType.kStreamIn;
   config: synapse.IStreamInConfig;

package/synapse-api/COPYRIGHT

@@ -0,0 +1 @@
+Copyright 2024 Science Corporation. All rights reserved.

package/synapse-api/api/node.proto

@@ -11,6 +11,7 @@ import "api/nodes/spike_detect.proto";
 import "api/nodes/spectral_filter.proto";
 import "api/nodes/stream_out.proto";
 import "api/nodes/stream_in.proto";
+import "api/nodes/disk_writer.proto";
 
 enum NodeType {
   kNodeTypeUnknown = 0;
@@ -22,6 +23,7 @@ enum NodeType {
   kOpticalStimulation = 6;
   kSpikeDetect = 7;
   kSpectralFilter = 8;
+  kDiskWriter = 9;
 }
 
 message NodeConfig {
@@ -36,6 +38,18 @@ message NodeConfig {
     OpticalStimulationConfig optical_stimulation = 8;
     SpikeDetectConfig spike_detect = 9;
     SpectralFilterConfig spectral_filter = 10;
+    DiskWriterConfig disk_writer = 11;
+  }
+}
+
+message NodeStatus {
+  NodeType type = 1;
+  uint32 id = 2;
+  oneof status {
+    StreamOutStatus stream_out = 3;
+    ElectricalBroadbandStatus electrical_broadband = 4;
+    StreamInStatus stream_in = 5;
+    ElectricalStimulationStatus electrical_stimulation = 6;
   }
 }
 

package/synapse-api/api/nodes/disk_writer.proto

@@ -0,0 +1,7 @@
+syntax = "proto3";
+
+package synapse;
+
+message DiskWriterConfig {
+  string filename = 1;
+}

package/synapse-api/api/nodes/electrical_broadband.proto

@@ -13,3 +13,7 @@ message ElectricalBroadbandConfig {
   float low_cutoff_hz = 6;
   float high_cutoff_hz = 7;
 }
+
+message ElectricalBroadbandStatus {
+  float lsb_uV = 1;
+}

package/synapse-api/api/nodes/electrical_stimulation.proto

@@ -11,3 +11,7 @@ message ElectricalStimulationConfig {
   uint32 sample_rate = 4;
   uint32 lsb = 5;
 }
+
+message ElectricalStimulationStatus {
+  float lsb_uV = 1;
+}

package/synapse-api/api/nodes/spectral_filter.proto

@@ -14,4 +14,5 @@ message SpectralFilterConfig {
   SpectralFilterMethod method = 1;
   float low_cutoff_hz = 2;
   float high_cutoff_hz = 3;
+  float sample_rate_hz = 4;
 }

package/synapse-api/api/nodes/stream_in.proto

@@ -6,4 +6,9 @@ package synapse;
 
 message StreamInConfig {
   DataType data_type = 1;
+  repeated uint32 shape = 2;
 }
+
+message StreamInStatus {
+  float throughput_mbps = 1;
+}

package/synapse-api/api/nodes/stream_out.proto

@@ -6,3 +6,7 @@ message StreamOutConfig {
   string label = 1;
   string multicast_group = 2;
 }
+
+message StreamOutStatus {
+  float throughput_mbps = 1;
+}

package/synapse-api/api/status.proto

@@ -12,6 +12,7 @@ enum StatusCode {
   kUnimplemented = 4;
   kInternalError = 5;
   kPermissionDenied = 6;
+  kQueryFailed = 7;
 }
 
 enum DeviceState {
@@ -32,6 +33,10 @@ message DevicePower {
   bool is_charging = 2;
 }
 
+message SignalChainStatus {
+  repeated NodeStatus nodes = 1;
+}
+
 message Status {
   string message = 1;
   StatusCode code = 2;
@@ -39,4 +44,5 @@ message Status {
   repeated NodeSocket sockets = 4;
   DevicePower power = 5;
   DeviceStorage storage = 6;
+  SignalChainStatus signal_chain = 7;
 }

package/synapse-api/api/synapse.proto

@@ -20,6 +20,7 @@ message Peripheral {
   string vendor = 2;
   uint32 peripheral_id = 3;
   Type type = 4;
+  string address = 5;
 }
 
 message DeviceInfo {