@science-corporation/synapse 0.13.0 → 2.0.0

package/synapse-api/api/node.proto

@@ -6,12 +6,13 @@ import "api/datatype.proto";
 import "api/nodes/broadband_source.proto";
 import "api/nodes/electrical_stimulation.proto";
 import "api/nodes/optical_stimulation.proto";
-import "api/nodes/spike_detect.proto";
+import "api/nodes/spike_detector.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";
 import "api/nodes/spike_source.proto";
+import "api/nodes/spike_binner.proto";
 
 enum NodeType {
   kNodeTypeUnknown = 0;
@@ -20,10 +21,11 @@ enum NodeType {
   kBroadbandSource = 3;
   kElectricalStimulation = 4;
   kOpticalStimulation = 5;
-  kSpikeDetect = 6;
+  kSpikeDetector = 6;
   kSpikeSource = 7;
   kSpectralFilter = 8;
   kDiskWriter = 9;
+  kSpikeBinner = 10;
 }
 
 message NodeConfig {
@@ -35,10 +37,11 @@ message NodeConfig {
     BroadbandSourceConfig broadband_source = 5;
     ElectricalStimulationConfig electrical_stimulation = 6;
     OpticalStimulationConfig optical_stimulation = 8;
-    SpikeDetectConfig spike_detect = 9;
+    SpikeDetectorConfig spike_detector = 9;
     SpectralFilterConfig spectral_filter = 10;
     DiskWriterConfig disk_writer = 11;
     SpikeSourceConfig spike_source = 12;
+    SpikeBinnerConfig spike_binner = 13;
   }
 }
 

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

@@ -0,0 +1,7 @@
+syntax = "proto3";
+
+package synapse;
+
+message SpikeBinnerConfig {
+  uint32 bin_size_ms = 1;
+}

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

@@ -0,0 +1,19 @@
+syntax = "proto3";
+
+package synapse;
+
+message TemplateMatcher {
+  repeated uint32 template_uV = 1;
+}
+
+message Thresholder {
+  uint32 threshold_uV = 1;
+}
+
+message SpikeDetectorConfig {
+  oneof config {
+    Thresholder thresholder = 1;
+    TemplateMatcher template_matcher = 2;
+  }
+  uint32 samples_per_spike = 3;
+}

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

@@ -2,11 +2,41 @@ syntax = "proto3";
 
 package synapse;
 
+/**
+ * UDPUnicastConfig defines the configuration parameters for UDP unicast transport.
+ */
+message UDPUnicastConfig {
+  // IPv4 or IPv6 address of the destination endpoint
+  string destination_address = 1;
+
+  // Destination port number, 0 to 65535
+  uint32 destination_port = 2;
+}
+
+/**
+ * StreamOutConfig defines the configuration for an outbound data stream.
+ * Clients can request to create a new outbound stream by providing a transport
+ */
 message StreamOutConfig {
+  // Human-readable identifier for the stream
   string label = 1;
-  string multicast_group = 2;
+
+  // Transport-specific configuration
+  // Only one transport type can be specified at a time
+  oneof transport {
+    // Configure for UDP unicast support. Only one destination is supported
+    UDPUnicastConfig udp_unicast = 2;
+  }
 }
 
+/**
+ * StreamOutStatus provides status information for an outbound stream.
+ * It contains data about the instantaneous performance of the stream
+ */
 message StreamOutStatus {
+  // Current throughput of the stream in megabits per second
   float throughput_mbps = 1;
+
+  // How many failed packet sends have happened since the start of the stream
+  uint64 failed_send_count = 2;
 }

package/synapse-api/api/query.proto

@@ -55,6 +55,12 @@ message QueryRequest {
   }
 }
 
+message StreamQueryRequest {
+  QueryRequest request = 1;
+
+  // Other options to fill in specific to a stream
+}
+
 message QueryResponse {
   Status status = 1;
   repeated uint32 data = 2;
@@ -62,4 +68,16 @@ message QueryResponse {
     ImpedanceResponse impedance_response = 3;
     SelfTestResponse self_test_response = 4;
   }
-}
+}
+
+message StreamQueryResponse {
+  StatusCode code = 1;
+  string message = 2;
+  uint64 timestamp_ns = 3;
+  
+  // We need to switch on the test being run
+  oneof response {
+    ImpedanceResponse impedance = 4;
+    SelfTestResponse self_test = 5;
+  }
+}

package/synapse-api/api/synapse.proto

@@ -45,6 +45,7 @@ service SynapseDevice {
   rpc Start(google.protobuf.Empty) returns (Status) {}
   rpc Stop(google.protobuf.Empty) returns (Status) {}
   rpc Query(QueryRequest) returns (QueryResponse) {}
+  rpc StreamQuery(StreamQueryRequest) returns (stream StreamQueryResponse) {}
 
   rpc ListFiles(google.protobuf.Empty) returns (ListFilesResponse) {}
   rpc WriteFile(WriteFileRequest) returns (WriteFileResponse) {}

package/dist/api-science-device/api.d.ts

@@ -1,3 +0,0 @@
-declare const _exports: any;
-export = _exports;
-//# sourceMappingURL=api.d.ts.map

package/dist/api-science-device/api.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"api.d.ts","sourceRoot":"","sources":["../../src/api-science-device/api.js"],"names":[],"mappings":""}