@science-corporation/synapse 0.10.0 → 0.13.0

package/src/api/proto.json

@@ -2,19 +2,11 @@
   "nested": {
     "synapse": {
       "nested": {
-        "SpectralFilterMethod": {
-          "values": {
-            "kSpectralFilterUnknown": 0,
-            "kLowPass": 1,
-            "kHighPass": 2,
-            "kBandPass": 3,
-            "kBandStop": 4
-          }
-        },
-        "SpectralFilterConfig": {
+        "ElectrodeConfig": {
           "fields": {
-            "method": {
-              "type": "SpectralFilterMethod",
+            "channels": {
+              "rule": "repeated",
+              "type": "Channel",
               "id": 1
             },
             "lowCutoffHz": {
@@ -24,63 +16,108 @@
             "highCutoffHz": {
               "type": "float",
               "id": 3
-            },
-            "sampleRateHz": {
-              "type": "float",
-              "id": 4
             }
           }
         },
-        "ElectricalStimulationConfig": {
+        "PixelConfig": {
           "fields": {
-            "peripheralId": {
+            "pixelMask": {
+              "rule": "repeated",
               "type": "uint32",
               "id": 1
+            }
+          }
+        },
+        "SignalConfig": {
+          "oneofs": {
+            "signalType": {
+              "oneof": [
+                "electrode",
+                "pixel"
+              ]
+            }
+          },
+          "fields": {
+            "electrode": {
+              "type": "ElectrodeConfig",
+              "id": 1
             },
-            "channels": {
-              "rule": "repeated",
-              "type": "Channel",
+            "pixel": {
+              "type": "PixelConfig",
               "id": 2
-            },
-            "bitWidth": {
+            }
+          }
+        },
+        "Channel": {
+          "fields": {
+            "id": {
               "type": "uint32",
-              "id": 3
+              "id": 1
             },
-            "sampleRate": {
+            "electrodeId": {
               "type": "uint32",
-              "id": 4
+              "id": 2
             },
-            "lsb": {
+            "referenceId": {
               "type": "uint32",
-              "id": 5
+              "id": 3
             }
           }
         },
-        "ElectricalStimulationStatus": {
+        "SpectralFilterMethod": {
+          "values": {
+            "kSpectralFilterUnknown": 0,
+            "kLowPass": 1,
+            "kHighPass": 2,
+            "kBandPass": 3,
+            "kBandStop": 4
+          }
+        },
+        "SpectralFilterConfig": {
           "fields": {
-            "lsbUV": {
-              "type": "float",
+            "method": {
+              "type": "SpectralFilterMethod",
               "id": 1
+            },
+            "lowCutoffHz": {
+              "type": "float",
+              "id": 2
+            },
+            "highCutoffHz": {
+              "type": "float",
+              "id": 3
             }
           }
         },
-        "Channel": {
+        "SpikeSourceConfig": {
           "fields": {
-            "id": {
+            "peripheralId": {
               "type": "uint32",
               "id": 1
             },
-            "electrodeId": {
+            "sampleRateHz": {
               "type": "uint32",
               "id": 2
             },
-            "referenceId": {
-              "type": "uint32",
+            "spikeWindowMs": {
+              "type": "float",
               "id": 3
+            },
+            "gain": {
+              "type": "float",
+              "id": 4
+            },
+            "thresholdUV": {
+              "type": "float",
+              "id": 5
+            },
+            "electrodes": {
+              "type": "ElectrodeConfig",
+              "id": 6
             }
           }
         },
-        "ElectricalBroadbandConfig": {
+        "ElectricalStimulationConfig": {
           "fields": {
             "peripheralId": {
               "type": "uint32",
@@ -99,21 +136,13 @@
               "type": "uint32",
               "id": 4
             },
-            "gain": {
-              "type": "float",
+            "lsb": {
+              "type": "uint32",
               "id": 5
-            },
-            "lowCutoffHz": {
-              "type": "float",
-              "id": 6
-            },
-            "highCutoffHz": {
-              "type": "float",
-              "id": 7
             }
           }
         },
-        "ElectricalBroadbandStatus": {
+        "ElectricalStimulationStatus": {
           "fields": {
             "lsbUV": {
               "type": "float",
@@ -214,31 +243,69 @@
             }
           }
         },
-        "OpticalBroadbandConfig": {
+        "ElectrodeStatus": {
+          "fields": {
+            "lsbUV": {
+              "type": "float",
+              "id": 1
+            }
+          }
+        },
+        "PixelStatus": {
+          "fields": {}
+        },
+        "SignalStatus": {
+          "oneofs": {
+            "signalType": {
+              "oneof": [
+                "electrode",
+                "pixel"
+              ]
+            }
+          },
+          "fields": {
+            "electrode": {
+              "type": "ElectrodeStatus",
+              "id": 1
+            },
+            "pixel": {
+              "type": "PixelStatus",
+              "id": 2
+            }
+          }
+        },
+        "BroadbandSourceConfig": {
           "fields": {
             "peripheralId": {
               "type": "uint32",
               "id": 1
             },
-            "pixelMask": {
-              "rule": "repeated",
+            "bitWidth": {
               "type": "uint32",
               "id": 2
             },
-            "bitWidth": {
+            "sampleRateHz": {
               "type": "uint32",
               "id": 3
             },
-            "frameRate": {
-              "type": "uint32",
+            "gain": {
+              "type": "float",
               "id": 4
             },
-            "gain": {
-              "type": "uint32",
+            "signal": {
+              "type": "SignalConfig",
               "id": 5
             }
           }
         },
+        "BroadbandSourceStatus": {
+          "fields": {
+            "status": {
+              "type": "SignalStatus",
+              "id": 1
+            }
+          }
+        },
         "OpticalStimulationConfig": {
           "fields": {
             "peripheralId": {
@@ -291,10 +358,10 @@
             "Type": {
               "values": {
                 "kUnknown": 0,
-                "kElectricalRecord": 1,
+                "kBroadbandSource": 1,
                 "kElectricalStimulation": 2,
                 "kOpticalStimulation": 3,
-                "kOpticalRecord": 4
+                "kSpikeSource": 4
               }
             }
           }
@@ -384,6 +451,15 @@
             "DeleteFile": {
               "requestType": "DeleteFileRequest",
               "responseType": "DeleteFileResponse"
+            },
+            "GetLogs": {
+              "requestType": "LogQueryRequest",
+              "responseType": "LogQueryResponse"
+            },
+            "TailLogs": {
+              "requestType": "TailLogsRequest",
+              "responseType": "LogEntry",
+              "responseStream": true
             }
           }
         },
@@ -392,11 +468,11 @@
             "kNodeTypeUnknown": 0,
             "kStreamIn": 1,
             "kStreamOut": 2,
-            "kElectricalBroadband": 3,
+            "kBroadbandSource": 3,
             "kElectricalStimulation": 4,
-            "kOpticalBroadband": 5,
-            "kOpticalStimulation": 6,
-            "kSpikeDetect": 7,
+            "kOpticalStimulation": 5,
+            "kSpikeDetect": 6,
+            "kSpikeSource": 7,
             "kSpectralFilter": 8,
             "kDiskWriter": 9
           }
@@ -407,13 +483,13 @@
               "oneof": [
                 "streamOut",
                 "streamIn",
-                "electricalBroadband",
+                "broadbandSource",
                 "electricalStimulation",
-                "opticalBroadband",
                 "opticalStimulation",
                 "spikeDetect",
                 "spectralFilter",
-                "diskWriter"
+                "diskWriter",
+                "spikeSource"
               ]
             }
           },
@@ -434,18 +510,14 @@
               "type": "StreamInConfig",
               "id": 4
             },
-            "electricalBroadband": {
-              "type": "ElectricalBroadbandConfig",
+            "broadbandSource": {
+              "type": "BroadbandSourceConfig",
               "id": 5
             },
             "electricalStimulation": {
               "type": "ElectricalStimulationConfig",
               "id": 6
             },
-            "opticalBroadband": {
-              "type": "OpticalBroadbandConfig",
-              "id": 7
-            },
             "opticalStimulation": {
               "type": "OpticalStimulationConfig",
               "id": 8
@@ -461,6 +533,10 @@
             "diskWriter": {
               "type": "DiskWriterConfig",
               "id": 11
+            },
+            "spikeSource": {
+              "type": "SpikeSourceConfig",
+              "id": 12
             }
           }
         },
@@ -469,7 +545,7 @@
             "status": {
               "oneof": [
                 "streamOut",
-                "electricalBroadband",
+                "broadbandSource",
                 "streamIn",
                 "electricalStimulation"
               ]
@@ -488,8 +564,8 @@
               "type": "StreamOutStatus",
               "id": 3
             },
-            "electricalBroadband": {
-              "type": "ElectricalBroadbandStatus",
+            "broadbandSource": {
+              "type": "BroadbandSourceStatus",
               "id": 4
             },
             "streamIn": {
@@ -565,6 +641,14 @@
             }
           }
         },
+        "SelfTestQuery": {
+          "fields": {
+            "peripheralId": {
+              "type": "uint32",
+              "id": 1
+            }
+          }
+        },
         "ImpedanceMeasurement": {
           "fields": {
             "electrodeId": {
@@ -590,12 +674,47 @@
             }
           }
         },
+        "SelfTestItem": {
+          "fields": {
+            "testName": {
+              "type": "string",
+              "id": 1
+            },
+            "passed": {
+              "type": "bool",
+              "id": 2
+            },
+            "testData": {
+              "rule": "repeated",
+              "type": "uint32",
+              "id": 3
+            },
+            "testReport": {
+              "type": "string",
+              "id": 4
+            }
+          }
+        },
+        "SelfTestResponse": {
+          "fields": {
+            "allPassed": {
+              "type": "bool",
+              "id": 1
+            },
+            "tests": {
+              "rule": "repeated",
+              "type": "SelfTestItem",
+              "id": 2
+            }
+          }
+        },
         "QueryRequest": {
           "oneofs": {
             "query": {
               "oneof": [
                 "impedanceQuery",
-                "sampleQuery"
+                "sampleQuery",
+                "selfTestQuery"
               ]
             }
           },
@@ -611,6 +730,10 @@
             "sampleQuery": {
               "type": "SampleQuery",
               "id": 3
+            },
+            "selfTestQuery": {
+              "type": "SelfTestQuery",
+              "id": 4
             }
           },
           "nested": {
@@ -618,7 +741,8 @@
               "values": {
                 "kNone": 0,
                 "kImpedance": 1,
-                "kSample": 2
+                "kSample": 2,
+                "kSelfTest": 3
               }
             }
           }
@@ -627,7 +751,8 @@
           "oneofs": {
             "response": {
               "oneof": [
-                "impedanceResponse"
+                "impedanceResponse",
+                "selfTestResponse"
               ]
             }
           },
@@ -644,6 +769,10 @@
             "impedanceResponse": {
               "type": "ImpedanceResponse",
               "id": 3
+            },
+            "selfTestResponse": {
+              "type": "SelfTestResponse",
+              "id": 4
             }
           }
         },
@@ -840,6 +969,73 @@
               "id": 2
             }
           }
+        },
+        "LogLevel": {
+          "values": {
+            "LOG_LEVEL_UNKNOWN": 0,
+            "LOG_LEVEL_DEBUG": 1,
+            "LOG_LEVEL_INFO": 2,
+            "LOG_LEVEL_WARNING": 3,
+            "LOG_LEVEL_ERROR": 4,
+            "LOG_LEVEL_CRITICAL": 5
+          }
+        },
+        "LogEntry": {
+          "fields": {
+            "timestampNs": {
+              "type": "uint64",
+              "id": 1
+            },
+            "level": {
+              "type": "LogLevel",
+              "id": 2
+            },
+            "source": {
+              "type": "string",
+              "id": 3
+            },
+            "message": {
+              "type": "string",
+              "id": 4
+            }
+          }
+        },
+        "LogQueryRequest": {
+          "fields": {
+            "startTimeNs": {
+              "type": "uint64",
+              "id": 1
+            },
+            "endTimeNs": {
+              "type": "uint64",
+              "id": 2
+            },
+            "sinceMs": {
+              "type": "uint64",
+              "id": 3
+            },
+            "minLevel": {
+              "type": "LogLevel",
+              "id": 4
+            }
+          }
+        },
+        "LogQueryResponse": {
+          "fields": {
+            "entries": {
+              "rule": "repeated",
+              "type": "LogEntry",
+              "id": 1
+            }
+          }
+        },
+        "TailLogsRequest": {
+          "fields": {
+            "minLevel": {
+              "type": "LogLevel",
+              "id": 1
+            }
+          }
         }
       }
     },

package/src/browser.ts

@@ -0,0 +1,4 @@
+// Browser-safe exports (types and enums only)
+export type { CallOptions } from "./utils/client";
+export { IStatus, Status, StatusCode } from "./utils/status";
+export * from "./api/api";

package/src/config.ts

@@ -1,19 +1,22 @@
 import Node from "./node";
 import { synapse } from "./api/api";
-import ElectricalBroadband from "./nodes/electrical_broadband";
+import BroadbandSource from "./nodes/broadband_source";
+import DiskWriter from "./nodes/disk_writer";
 import ElectricalStimulation from "./nodes/electrical_stimulation";
-import OpticalBroadband from "./nodes/optical_broadband";
 import OpticalStimulation from "./nodes/optical_stimulation";
 import SpectralFilter from "./nodes/spectral_filter";
 import SpikeDetect from "./nodes/spike_detect";
+import SpikeSource from "./nodes/spike_source";
 import StreamIn from "./nodes/stream_in";
 import StreamOut from "./nodes/stream_out";
+import { Status, StatusCode } from "./utils/status";
 
 type Connection = [number, number];
 const kNodeTypeObjectMap = {
-  [synapse.NodeType.kElectricalBroadband]: ElectricalBroadband,
+  [synapse.NodeType.kBroadbandSource]: BroadbandSource,
+  [synapse.NodeType.kDiskWriter]: DiskWriter,
   [synapse.NodeType.kElectricalStimulation]: ElectricalStimulation,
-  [synapse.NodeType.kOpticalBroadband]: OpticalBroadband,
+  [synapse.NodeType.kSpikeSource]: SpikeSource,
   [synapse.NodeType.kOpticalStimulation]: OpticalStimulation,
   [synapse.NodeType.kSpectralFilter]: SpectralFilter,
   [synapse.NodeType.kSpikeDetect]: SpikeDetect,
@@ -29,37 +32,47 @@ class Config {
     return this.nodes.length + 1;
   }
 
-  add(nodes: Node[]) {
+  add(nodes: Node[]): Status {
     for (const node of nodes) {
-      if (!this.addNode(node)) {
-        return false;
+      const status = this.addNode(node);
+      if (!status.ok()) {
+        return status;
       }
     }
-    return true;
+    return new Status();
   }
 
-  connect(fromNode: Node, toNode: Node): boolean {
-    if (fromNode.id === null || toNode.id === null) {
-      return false;
+  connect(fromNode: Node, toNode: Node): Status {
+    if (!fromNode.id || !toNode.id) {
+      return new Status(StatusCode.INVALID_ARGUMENT, "source and destination nodes must have ids");
     }
     this.connections.push([fromNode.id, toNode.id]);
-    return true;
+    return new Status();
   }
 
-  addNode(node: Node): boolean {
-    if (!!node.id) {
-      return false;
+  addNode(node: Node, id?: number): Status {
+    if (node.id) {
+      return new Status(StatusCode.INVALID_ARGUMENT, "node must not have an id");
     }
-    node.id = this._genNodeId();
+
+    if (id === undefined) {
+      id = this._genNodeId();
+    }
+
+    if (this.nodes.find((n) => n.id === id)) {
+      return new Status(StatusCode.INVALID_ARGUMENT, "node id must be unique");
+    }
+
+    node.id = id;
     this.nodes.push(node);
-    return true;
+    return new Status();
   }
 
-  setDevice(device): boolean {
+  setDevice(device): Status {
     for (const node of this.nodes) {
       node.device = device;
     }
-    return true;
+    return new Status();
   }
 
   static fromProto(proto: synapse.IDeviceConfiguration): Config {
@@ -74,7 +87,7 @@ class Config {
       }
 
       const node = NodeType.fromProto(nodeProto);
-      if (!!nodeProto.id) {
+      if (nodeProto.id) {
         node.id = nodeProto.id;
         config.nodes.push(node);
       } else {