@science-corporation/synapse 2.2.8 → 2.3.0

package/synapse-api/README.md

@@ -1,4 +1,4 @@
-# Synapse API 2.0.0
+# Synapse API 2.1.0
 
 The Synapse Protocol defines a standard interface for interacting with a wide range of possible neural interface devices.
 

package/synapse-api/api/datatype.proto

@@ -107,3 +107,26 @@ message AnnotatedTensor {
   // e.g. pipeline latencies
   map<string, google.protobuf.Value> metadata = 2;
 }
+
+enum PixelFormat {
+  kPixelFormatUnknown = 0;
+  kYUV420_888 = 1;
+  kRGB888 = 2;
+  kRGBA8888 = 3;
+  kGrayscale8 = 4;
+  kRAW10 = 5;
+  kRAW16 = 6;
+  kNV12 = 7;
+  kNV21 = 8;
+}
+
+message ImageFrame {
+  uint32 width = 1;
+  uint32 height = 2;
+  PixelFormat format = 3;
+  uint32 sample_rate_hz = 4;
+  uint64 sequence_number = 5;
+  uint64 timestamp_ns = 6;
+  uint64 unix_timestamp_ns = 7;
+  bytes data = 8;
+}

package/synapse-api/api/device.proto

@@ -4,7 +4,8 @@ package synapse;
 
 import "api/node.proto";
 import "api/status.proto";
-import "api/time.proto";
+
+import "google/protobuf/struct.proto";
 
 message Peripheral {
     enum Type {
@@ -13,6 +14,7 @@ message Peripheral {
       kElectricalStimulation = 2;
       kOpticalStimulation = 3;
       kSpikeSource = 4;
+      kCamera = 5;
     }
     string name = 1;
     string vendor = 2;
@@ -37,13 +39,35 @@ message DeviceConfiguration {
 }
 
 
-// Device settings that are configurable by the user
+// Device settings that are configurable by the user.
+// Keys and value types are defined by the device and advertised via
+// GetSettingsResponse.schema.
 message DeviceSettings {
+    reserved 1, 2, 3;
+    reserved "name", "time_source", "fpga_clock_freq_hz";
+
+    google.protobuf.Struct values = 4;
+}
+
+// Describes a single settings key that the device accepts.
+message SettingDescriptor {
+    enum Kind {
+        kKindUnknown = 0;
+        kString = 1;
+        kInt = 2;
+        kDouble = 3;
+        kBool = 4;
+        kEnum = 5;
+    }
+
     string name = 1;
-    TimeSource time_source = 2;
+    string description = 2;
+    Kind kind = 3;
+    google.protobuf.Value default_value = 4;
 
-    // If configurable, the desired FPGA clock frequency in hz
-    uint32 fpga_clock_freq_hz = 3;
+    // Allowed values for enum-kind or discrete-set settings
+    // (e.g. valid FPGA clock frequencies).
+    repeated google.protobuf.Value allowed_values = 5;
 }
 
 message GetSettingsQuery {
@@ -52,10 +76,13 @@ message GetSettingsQuery {
 
 message GetSettingsResponse {
     DeviceSettings settings = 1;
+
+    // Describes the keys this device accepts in DeviceSettings.values.
+    repeated SettingDescriptor schema = 2;
 }
 
 message UpdateDeviceSettingsRequest {
-    // If a field isn't populated, it will not be changed
+    // Only keys present in settings.values will be updated.
     DeviceSettings settings = 1;
 }
 

package/synapse-api/api/node.proto

@@ -11,6 +11,7 @@ import "api/nodes/disk_writer.proto";
 import "api/nodes/spike_source.proto";
 import "api/nodes/spike_binner.proto";
 import "api/nodes/application.proto";
+import "api/nodes/camera.proto";
 
 enum NodeType {
   kNodeTypeUnknown = 0;
@@ -27,6 +28,7 @@ enum NodeType {
   kDiskWriter = 9;
   kSpikeBinner = 10;
   kApplication = 11;
+  kCamera = 12;
 }
 
 message NodeConfig {
@@ -47,6 +49,7 @@ message NodeConfig {
     SpikeSourceConfig spike_source = 12;
     SpikeBinnerConfig spike_binner = 13;
     ApplicationNodeConfig application = 14;
+    CameraConfig camera = 15;
   }
 }
 
@@ -63,6 +66,7 @@ message NodeStatus {
     ApplicationNodeStatus application = 7;
     OpticalStimulationStatus optical_stimulation = 8;
     DiskWriterStatus disk_writer = 10;
+    CameraStatus camera = 11;
   }
 }
 

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

@@ -0,0 +1,18 @@
+syntax = "proto3";
+
+package synapse;
+
+import "api/datatype.proto";
+
+message CameraConfig {
+  uint32 peripheral_id = 1;
+  uint32 width = 2;
+  uint32 height = 3;
+  PixelFormat format = 4;
+  uint32 frame_rate_hz = 5;
+}
+
+message CameraStatus {
+  uint64 frames_produced = 1;
+  uint64 frames_dropped = 2;
+}

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

@@ -4,6 +4,7 @@ package synapse;
 
 message DiskWriterConfig {
   string filename = 1;
+  uint32 storage_device_id = 2;
 }
 
 message DiskWriterStatus {

package/synapse-api/api/status.proto

@@ -23,9 +23,16 @@ enum DeviceState {
   kError = 4;
 }
 
+message StorageDevice {
+  string name = 1;
+  uint32 storage_device_id = 2;
+  float total_gb = 3;
+  float used_gb = 4;
+}
+
 message DeviceStorage {
-  float total_gb = 1;
-  float used_gb = 2;
+  reserved 1, 2;
+  repeated StorageDevice storage_devices = 3;
 }
 
 message DevicePower {