break: Remove Electrical/Optical broadband - make single BroadbandCon…

…fig (#29)

# Summary
Breaking changes made to the API regarding Broadband naming. Specifically

  * Removes NodeType::kElectricalBroadband
  * Removes NodeType::kOpticalBroadband
  * Adds NodeType::kBroadbandSource
  * Adds NodeType::kSpikeSource
  * Refactors the BroadbandSourceConfig to have a oneof for the signal type and consolidates the shared fields

# Testing
  * Added a CI for compilation

.github/workflows/proto-check.yaml

@@ -0,0 +1,33 @@
+name: Proto Compilation Check
+
+on:
+  push:
+    paths:
+      - '**.proto'
+  pull_request:
+    paths:
+      - '**.proto'
+
+jobs:
+  check-proto:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Install Protobuf Compiler
+      run: |
+        sudo apt-get update
+        sudo apt-get install -y protobuf-compiler
+    
+    - name: Check protoc version
+      run: protoc --version
+
+    - name: Create temp directory for compilation
+      run: mkdir -p /tmp/proto_compiled
+
+    - name: Compile Proto files
+      run: |
+        PROTO_FILES=$(find api -name '*.proto')
+        echo "Compiling $PROTO_FILES" 
+        protoc --proto_path=. $PROTO_FILES --cpp_out=/tmp/proto_compiled

README.md

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

api/node.proto

@@ -3,25 +3,25 @@ syntax = "proto3";
 package synapse;
 
 import "api/datatype.proto";
-import "api/nodes/electrical_broadband.proto";
+import "api/nodes/broadband_source.proto";
 import "api/nodes/electrical_stimulation.proto";
-import "api/nodes/optical_broadband.proto";
 import "api/nodes/optical_stimulation.proto";
 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";
+import "api/nodes/spike_source.proto";
 
 enum NodeType {
   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;
 }
@@ -32,13 +32,13 @@ message NodeConfig {
   oneof config {
     StreamOutConfig stream_out = 3;
     StreamInConfig stream_in = 4;
-    ElectricalBroadbandConfig electrical_broadband = 5;
+    BroadbandSourceConfig broadband_source = 5;
     ElectricalStimulationConfig electrical_stimulation = 6;
-    OpticalBroadbandConfig optical_broadband = 7;
     OpticalStimulationConfig optical_stimulation = 8;
     SpikeDetectConfig spike_detect = 9;
     SpectralFilterConfig spectral_filter = 10;
     DiskWriterConfig disk_writer = 11;
+    SpikeSourceConfig spike_source = 12;
   }
 }
 
@@ -47,7 +47,7 @@ message NodeStatus {
   uint32 id = 2;
   oneof status {
     StreamOutStatus stream_out = 3;
-    ElectricalBroadbandStatus electrical_broadband = 4;
+    BroadbandSourceStatus broadband_source = 4;
     StreamInStatus stream_in = 5;
     ElectricalStimulationStatus electrical_stimulation = 6;
   }

api/nodes/broadband_source.proto

@@ -0,0 +1,20 @@
+syntax  = "proto3";
+
+import "api/nodes/signal_config.proto";
+import "api/nodes/signal_status.proto";
+
+package synapse;
+
+message BroadbandSourceConfig {
+    uint32 peripheral_id = 1;
+    uint32 bit_width = 2;
+    uint32 sample_rate_hz = 3;
+    float gain = 4;
+
+    // Implementation specific configurations
+    SignalConfig signal = 5;
+}
+
+message BroadbandSourceStatus {
+    SignalStatus status = 1;
+}

api/nodes/signal_config.proto

@@ -0,0 +1,22 @@
+syntax = "proto3";
+
+import "api/channel.proto";
+
+package synapse;
+
+message ElectrodeConfig {
+    repeated Channel channels = 1;
+    float low_cutoff_hz = 2;
+    float high_cutoff_hz = 3;
+}
+
+message PixelConfig {
+    repeated uint32 pixel_mask = 1;
+}
+
+message SignalConfig {
+    oneof signal_type {
+        ElectrodeConfig electrode = 1;
+        PixelConfig pixel = 2;
+    }
+}

api/nodes/signal_status.proto

@@ -0,0 +1,18 @@
+syntax = "proto3";
+
+package synapse;
+
+message ElectrodeStatus {
+    float lsb_uV = 1;
+}
+
+message PixelStatus {
+
+}
+
+message SignalStatus {
+    oneof signal_type {
+        ElectrodeStatus electrode = 1;
+        PixelStatus pixel = 2;
+    }
+}

api/nodes/spike_source.proto

@@ -0,0 +1,16 @@
+syntax = "proto3";
+
+import "api/channel.proto";
+import "api/nodes/signal_config.proto";
+
+package synapse;
+
+message SpikeSourceConfig {
+    uint32 peripheral_id = 1;
+    uint32 sample_rate_hz = 2;
+    float spike_window_ms = 3;
+    float gain = 4;
+    float threshold_uV = 5;
+
+    ElectrodeConfig electrodes = 6;
+}

api/synapse.proto

@@ -11,10 +11,10 @@ import "api/files.proto";
 message Peripheral {
   enum Type {
     kUnknown = 0;
-    kElectricalRecord = 1;
+    kBroadbandSource = 1;
     kElectricalStimulation = 2;
     kOpticalStimulation = 3;
-    kOpticalRecord = 4;
+    kSpikeSource = 4;
   }
   string name = 1;
   string vendor = 2;