@science-corporation/synapse 0.12.0 → 1.1.0

package/src/api/api.js

@@ -3264,6 +3264,233 @@
             return DiskWriterConfig;
         })();
     
+        synapse.UDPUnicastConfig = (function() {
+    
+            /**
+             * Properties of a UDPUnicastConfig.
+             * @memberof synapse
+             * @interface IUDPUnicastConfig
+             * @property {string|null} [destinationAddress] UDPUnicastConfig destinationAddress
+             * @property {number|null} [destinationPort] UDPUnicastConfig destinationPort
+             */
+    
+            /**
+             * Constructs a new UDPUnicastConfig.
+             * @memberof synapse
+             * @classdesc UDPUnicastConfig defines the configuration parameters for UDP unicast transport.
+             * @implements IUDPUnicastConfig
+             * @constructor
+             * @param {synapse.IUDPUnicastConfig=} [properties] Properties to set
+             */
+            function UDPUnicastConfig(properties) {
+                if (properties)
+                    for (var keys = Object.keys(properties), i = 0; i < keys.length; ++i)
+                        if (properties[keys[i]] != null)
+                            this[keys[i]] = properties[keys[i]];
+            }
+    
+            /**
+             * UDPUnicastConfig destinationAddress.
+             * @member {string} destinationAddress
+             * @memberof synapse.UDPUnicastConfig
+             * @instance
+             */
+            UDPUnicastConfig.prototype.destinationAddress = "";
+    
+            /**
+             * UDPUnicastConfig destinationPort.
+             * @member {number} destinationPort
+             * @memberof synapse.UDPUnicastConfig
+             * @instance
+             */
+            UDPUnicastConfig.prototype.destinationPort = 0;
+    
+            /**
+             * Creates a new UDPUnicastConfig instance using the specified properties.
+             * @function create
+             * @memberof synapse.UDPUnicastConfig
+             * @static
+             * @param {synapse.IUDPUnicastConfig=} [properties] Properties to set
+             * @returns {synapse.UDPUnicastConfig} UDPUnicastConfig instance
+             */
+            UDPUnicastConfig.create = function create(properties) {
+                return new UDPUnicastConfig(properties);
+            };
+    
+            /**
+             * Encodes the specified UDPUnicastConfig message. Does not implicitly {@link synapse.UDPUnicastConfig.verify|verify} messages.
+             * @function encode
+             * @memberof synapse.UDPUnicastConfig
+             * @static
+             * @param {synapse.IUDPUnicastConfig} message UDPUnicastConfig message or plain object to encode
+             * @param {$protobuf.Writer} [writer] Writer to encode to
+             * @returns {$protobuf.Writer} Writer
+             */
+            UDPUnicastConfig.encode = function encode(message, writer) {
+                if (!writer)
+                    writer = $Writer.create();
+                if (message.destinationAddress != null && Object.hasOwnProperty.call(message, "destinationAddress"))
+                    writer.uint32(/* id 1, wireType 2 =*/10).string(message.destinationAddress);
+                if (message.destinationPort != null && Object.hasOwnProperty.call(message, "destinationPort"))
+                    writer.uint32(/* id 2, wireType 0 =*/16).uint32(message.destinationPort);
+                return writer;
+            };
+    
+            /**
+             * Encodes the specified UDPUnicastConfig message, length delimited. Does not implicitly {@link synapse.UDPUnicastConfig.verify|verify} messages.
+             * @function encodeDelimited
+             * @memberof synapse.UDPUnicastConfig
+             * @static
+             * @param {synapse.IUDPUnicastConfig} message UDPUnicastConfig message or plain object to encode
+             * @param {$protobuf.Writer} [writer] Writer to encode to
+             * @returns {$protobuf.Writer} Writer
+             */
+            UDPUnicastConfig.encodeDelimited = function encodeDelimited(message, writer) {
+                return this.encode(message, writer).ldelim();
+            };
+    
+            /**
+             * Decodes a UDPUnicastConfig message from the specified reader or buffer.
+             * @function decode
+             * @memberof synapse.UDPUnicastConfig
+             * @static
+             * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from
+             * @param {number} [length] Message length if known beforehand
+             * @returns {synapse.UDPUnicastConfig} UDPUnicastConfig
+             * @throws {Error} If the payload is not a reader or valid buffer
+             * @throws {$protobuf.util.ProtocolError} If required fields are missing
+             */
+            UDPUnicastConfig.decode = function decode(reader, length) {
+                if (!(reader instanceof $Reader))
+                    reader = $Reader.create(reader);
+                var end = length === undefined ? reader.len : reader.pos + length, message = new $root.synapse.UDPUnicastConfig();
+                while (reader.pos < end) {
+                    var tag = reader.uint32();
+                    switch (tag >>> 3) {
+                    case 1: {
+                            message.destinationAddress = reader.string();
+                            break;
+                        }
+                    case 2: {
+                            message.destinationPort = reader.uint32();
+                            break;
+                        }
+                    default:
+                        reader.skipType(tag & 7);
+                        break;
+                    }
+                }
+                return message;
+            };
+    
+            /**
+             * Decodes a UDPUnicastConfig message from the specified reader or buffer, length delimited.
+             * @function decodeDelimited
+             * @memberof synapse.UDPUnicastConfig
+             * @static
+             * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from
+             * @returns {synapse.UDPUnicastConfig} UDPUnicastConfig
+             * @throws {Error} If the payload is not a reader or valid buffer
+             * @throws {$protobuf.util.ProtocolError} If required fields are missing
+             */
+            UDPUnicastConfig.decodeDelimited = function decodeDelimited(reader) {
+                if (!(reader instanceof $Reader))
+                    reader = new $Reader(reader);
+                return this.decode(reader, reader.uint32());
+            };
+    
+            /**
+             * Verifies a UDPUnicastConfig message.
+             * @function verify
+             * @memberof synapse.UDPUnicastConfig
+             * @static
+             * @param {Object.<string,*>} message Plain object to verify
+             * @returns {string|null} `null` if valid, otherwise the reason why it is not
+             */
+            UDPUnicastConfig.verify = function verify(message) {
+                if (typeof message !== "object" || message === null)
+                    return "object expected";
+                if (message.destinationAddress != null && message.hasOwnProperty("destinationAddress"))
+                    if (!$util.isString(message.destinationAddress))
+                        return "destinationAddress: string expected";
+                if (message.destinationPort != null && message.hasOwnProperty("destinationPort"))
+                    if (!$util.isInteger(message.destinationPort))
+                        return "destinationPort: integer expected";
+                return null;
+            };
+    
+            /**
+             * Creates a UDPUnicastConfig message from a plain object. Also converts values to their respective internal types.
+             * @function fromObject
+             * @memberof synapse.UDPUnicastConfig
+             * @static
+             * @param {Object.<string,*>} object Plain object
+             * @returns {synapse.UDPUnicastConfig} UDPUnicastConfig
+             */
+            UDPUnicastConfig.fromObject = function fromObject(object) {
+                if (object instanceof $root.synapse.UDPUnicastConfig)
+                    return object;
+                var message = new $root.synapse.UDPUnicastConfig();
+                if (object.destinationAddress != null)
+                    message.destinationAddress = String(object.destinationAddress);
+                if (object.destinationPort != null)
+                    message.destinationPort = object.destinationPort >>> 0;
+                return message;
+            };
+    
+            /**
+             * Creates a plain object from a UDPUnicastConfig message. Also converts values to other types if specified.
+             * @function toObject
+             * @memberof synapse.UDPUnicastConfig
+             * @static
+             * @param {synapse.UDPUnicastConfig} message UDPUnicastConfig
+             * @param {$protobuf.IConversionOptions} [options] Conversion options
+             * @returns {Object.<string,*>} Plain object
+             */
+            UDPUnicastConfig.toObject = function toObject(message, options) {
+                if (!options)
+                    options = {};
+                var object = {};
+                if (options.defaults) {
+                    object.destinationAddress = "";
+                    object.destinationPort = 0;
+                }
+                if (message.destinationAddress != null && message.hasOwnProperty("destinationAddress"))
+                    object.destinationAddress = message.destinationAddress;
+                if (message.destinationPort != null && message.hasOwnProperty("destinationPort"))
+                    object.destinationPort = message.destinationPort;
+                return object;
+            };
+    
+            /**
+             * Converts this UDPUnicastConfig to JSON.
+             * @function toJSON
+             * @memberof synapse.UDPUnicastConfig
+             * @instance
+             * @returns {Object.<string,*>} JSON object
+             */
+            UDPUnicastConfig.prototype.toJSON = function toJSON() {
+                return this.constructor.toObject(this, $protobuf.util.toJSONOptions);
+            };
+    
+            /**
+             * Gets the default type url for UDPUnicastConfig
+             * @function getTypeUrl
+             * @memberof synapse.UDPUnicastConfig
+             * @static
+             * @param {string} [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
+             * @returns {string} The default type url
+             */
+            UDPUnicastConfig.getTypeUrl = function getTypeUrl(typeUrlPrefix) {
+                if (typeUrlPrefix === undefined) {
+                    typeUrlPrefix = "type.googleapis.com";
+                }
+                return typeUrlPrefix + "/synapse.UDPUnicastConfig";
+            };
+    
+            return UDPUnicastConfig;
+        })();
+    
         synapse.StreamOutConfig = (function() {
     
             /**
@@ -3271,13 +3498,14 @@
              * @memberof synapse
              * @interface IStreamOutConfig
              * @property {string|null} [label] StreamOutConfig label
-             * @property {string|null} [multicastGroup] StreamOutConfig multicastGroup
+             * @property {synapse.IUDPUnicastConfig|null} [udpUnicast] StreamOutConfig udpUnicast
              */
     
             /**
              * Constructs a new StreamOutConfig.
              * @memberof synapse
-             * @classdesc Represents a StreamOutConfig.
+             * @classdesc StreamOutConfig defines the configuration for an outbound data stream.
+             * Clients can request to create a new outbound stream by providing a transport
              * @implements IStreamOutConfig
              * @constructor
              * @param {synapse.IStreamOutConfig=} [properties] Properties to set
@@ -3298,12 +3526,26 @@
             StreamOutConfig.prototype.label = "";
     
             /**
-             * StreamOutConfig multicastGroup.
-             * @member {string} multicastGroup
+             * StreamOutConfig udpUnicast.
+             * @member {synapse.IUDPUnicastConfig|null|undefined} udpUnicast
              * @memberof synapse.StreamOutConfig
              * @instance
              */
-            StreamOutConfig.prototype.multicastGroup = "";
+            StreamOutConfig.prototype.udpUnicast = null;
+    
+            // OneOf field names bound to virtual getters and setters
+            var $oneOfFields;
+    
+            /**
+             * StreamOutConfig transport.
+             * @member {"udpUnicast"|undefined} transport
+             * @memberof synapse.StreamOutConfig
+             * @instance
+             */
+            Object.defineProperty(StreamOutConfig.prototype, "transport", {
+                get: $util.oneOfGetter($oneOfFields = ["udpUnicast"]),
+                set: $util.oneOfSetter($oneOfFields)
+            });
     
             /**
              * Creates a new StreamOutConfig instance using the specified properties.
@@ -3331,8 +3573,8 @@
                     writer = $Writer.create();
                 if (message.label != null && Object.hasOwnProperty.call(message, "label"))
                     writer.uint32(/* id 1, wireType 2 =*/10).string(message.label);
-                if (message.multicastGroup != null && Object.hasOwnProperty.call(message, "multicastGroup"))
-                    writer.uint32(/* id 2, wireType 2 =*/18).string(message.multicastGroup);
+                if (message.udpUnicast != null && Object.hasOwnProperty.call(message, "udpUnicast"))
+                    $root.synapse.UDPUnicastConfig.encode(message.udpUnicast, writer.uint32(/* id 2, wireType 2 =*/18).fork()).ldelim();
                 return writer;
             };
     
@@ -3372,7 +3614,7 @@
                             break;
                         }
                     case 2: {
-                            message.multicastGroup = reader.string();
+                            message.udpUnicast = $root.synapse.UDPUnicastConfig.decode(reader, reader.uint32());
                             break;
                         }
                     default:
@@ -3410,12 +3652,18 @@
             StreamOutConfig.verify = function verify(message) {
                 if (typeof message !== "object" || message === null)
                     return "object expected";
+                var properties = {};
                 if (message.label != null && message.hasOwnProperty("label"))
                     if (!$util.isString(message.label))
                         return "label: string expected";
-                if (message.multicastGroup != null && message.hasOwnProperty("multicastGroup"))
-                    if (!$util.isString(message.multicastGroup))
-                        return "multicastGroup: string expected";
+                if (message.udpUnicast != null && message.hasOwnProperty("udpUnicast")) {
+                    properties.transport = 1;
+                    {
+                        var error = $root.synapse.UDPUnicastConfig.verify(message.udpUnicast);
+                        if (error)
+                            return "udpUnicast." + error;
+                    }
+                }
                 return null;
             };
     
@@ -3433,8 +3681,11 @@
                 var message = new $root.synapse.StreamOutConfig();
                 if (object.label != null)
                     message.label = String(object.label);
-                if (object.multicastGroup != null)
-                    message.multicastGroup = String(object.multicastGroup);
+                if (object.udpUnicast != null) {
+                    if (typeof object.udpUnicast !== "object")
+                        throw TypeError(".synapse.StreamOutConfig.udpUnicast: object expected");
+                    message.udpUnicast = $root.synapse.UDPUnicastConfig.fromObject(object.udpUnicast);
+                }
                 return message;
             };
     
@@ -3451,14 +3702,15 @@
                 if (!options)
                     options = {};
                 var object = {};
-                if (options.defaults) {
+                if (options.defaults)
                     object.label = "";
-                    object.multicastGroup = "";
-                }
                 if (message.label != null && message.hasOwnProperty("label"))
                     object.label = message.label;
-                if (message.multicastGroup != null && message.hasOwnProperty("multicastGroup"))
-                    object.multicastGroup = message.multicastGroup;
+                if (message.udpUnicast != null && message.hasOwnProperty("udpUnicast")) {
+                    object.udpUnicast = $root.synapse.UDPUnicastConfig.toObject(message.udpUnicast, options);
+                    if (options.oneofs)
+                        object.transport = "udpUnicast";
+                }
                 return object;
             };
     
@@ -3498,12 +3750,14 @@
              * @memberof synapse
              * @interface IStreamOutStatus
              * @property {number|null} [throughputMbps] StreamOutStatus throughputMbps
+             * @property {Long|null} [failedSendCount] StreamOutStatus failedSendCount
              */
     
             /**
              * Constructs a new StreamOutStatus.
              * @memberof synapse
-             * @classdesc Represents a StreamOutStatus.
+             * @classdesc StreamOutStatus provides status information for an outbound stream.
+             * It contains data about the instantaneous performance of the stream
              * @implements IStreamOutStatus
              * @constructor
              * @param {synapse.IStreamOutStatus=} [properties] Properties to set
@@ -3523,6 +3777,14 @@
              */
             StreamOutStatus.prototype.throughputMbps = 0;
     
+            /**
+             * StreamOutStatus failedSendCount.
+             * @member {Long} failedSendCount
+             * @memberof synapse.StreamOutStatus
+             * @instance
+             */
+            StreamOutStatus.prototype.failedSendCount = $util.Long ? $util.Long.fromBits(0,0,true) : 0;
+    
             /**
              * Creates a new StreamOutStatus instance using the specified properties.
              * @function create
@@ -3549,6 +3811,8 @@
                     writer = $Writer.create();
                 if (message.throughputMbps != null && Object.hasOwnProperty.call(message, "throughputMbps"))
                     writer.uint32(/* id 1, wireType 5 =*/13).float(message.throughputMbps);
+                if (message.failedSendCount != null && Object.hasOwnProperty.call(message, "failedSendCount"))
+                    writer.uint32(/* id 2, wireType 0 =*/16).uint64(message.failedSendCount);
                 return writer;
             };
     
@@ -3587,6 +3851,10 @@
                             message.throughputMbps = reader.float();
                             break;
                         }
+                    case 2: {
+                            message.failedSendCount = reader.uint64();
+                            break;
+                        }
                     default:
                         reader.skipType(tag & 7);
                         break;
@@ -3625,6 +3893,9 @@
                 if (message.throughputMbps != null && message.hasOwnProperty("throughputMbps"))
                     if (typeof message.throughputMbps !== "number")
                         return "throughputMbps: number expected";
+                if (message.failedSendCount != null && message.hasOwnProperty("failedSendCount"))
+                    if (!$util.isInteger(message.failedSendCount) && !(message.failedSendCount && $util.isInteger(message.failedSendCount.low) && $util.isInteger(message.failedSendCount.high)))
+                        return "failedSendCount: integer|Long expected";
                 return null;
             };
     
@@ -3642,6 +3913,15 @@
                 var message = new $root.synapse.StreamOutStatus();
                 if (object.throughputMbps != null)
                     message.throughputMbps = Number(object.throughputMbps);
+                if (object.failedSendCount != null)
+                    if ($util.Long)
+                        (message.failedSendCount = $util.Long.fromValue(object.failedSendCount)).unsigned = true;
+                    else if (typeof object.failedSendCount === "string")
+                        message.failedSendCount = parseInt(object.failedSendCount, 10);
+                    else if (typeof object.failedSendCount === "number")
+                        message.failedSendCount = object.failedSendCount;
+                    else if (typeof object.failedSendCount === "object")
+                        message.failedSendCount = new $util.LongBits(object.failedSendCount.low >>> 0, object.failedSendCount.high >>> 0).toNumber(true);
                 return message;
             };
     
@@ -3658,10 +3938,21 @@
                 if (!options)
                     options = {};
                 var object = {};
-                if (options.defaults)
+                if (options.defaults) {
                     object.throughputMbps = 0;
+                    if ($util.Long) {
+                        var long = new $util.Long(0, 0, true);
+                        object.failedSendCount = options.longs === String ? long.toString() : options.longs === Number ? long.toNumber() : long;
+                    } else
+                        object.failedSendCount = options.longs === String ? "0" : 0;
+                }
                 if (message.throughputMbps != null && message.hasOwnProperty("throughputMbps"))
                     object.throughputMbps = options.json && !isFinite(message.throughputMbps) ? String(message.throughputMbps) : message.throughputMbps;
+                if (message.failedSendCount != null && message.hasOwnProperty("failedSendCount"))
+                    if (typeof message.failedSendCount === "number")
+                        object.failedSendCount = options.longs === String ? String(message.failedSendCount) : message.failedSendCount;
+                    else
+                        object.failedSendCount = options.longs === String ? $util.Long.prototype.toString.call(message.failedSendCount) : options.longs === Number ? new $util.LongBits(message.failedSendCount.low >>> 0, message.failedSendCount.high >>> 0).toNumber(true) : message.failedSendCount;
                 return object;
             };
     

package/src/api/proto.json

@@ -223,14 +223,33 @@
             }
           }
         },
+        "UDPUnicastConfig": {
+          "fields": {
+            "destinationAddress": {
+              "type": "string",
+              "id": 1
+            },
+            "destinationPort": {
+              "type": "uint32",
+              "id": 2
+            }
+          }
+        },
         "StreamOutConfig": {
+          "oneofs": {
+            "transport": {
+              "oneof": [
+                "udpUnicast"
+              ]
+            }
+          },
           "fields": {
             "label": {
               "type": "string",
               "id": 1
             },
-            "multicastGroup": {
-              "type": "string",
+            "udpUnicast": {
+              "type": "UDPUnicastConfig",
               "id": 2
             }
           }
@@ -240,6 +259,10 @@
             "throughputMbps": {
               "type": "float",
               "id": 1
+            },
+            "failedSendCount": {
+              "type": "uint64",
+              "id": 2
             }
           }
         },

package/src/config.ts

@@ -1,6 +1,7 @@
 import Node from "./node";
 import { synapse } from "./api/api";
 import BroadbandSource from "./nodes/broadband_source";
+import DiskWriter from "./nodes/disk_writer";
 import ElectricalStimulation from "./nodes/electrical_stimulation";
 import OpticalStimulation from "./nodes/optical_stimulation";
 import SpectralFilter from "./nodes/spectral_filter";
@@ -13,6 +14,7 @@ import { Status, StatusCode } from "./utils/status";
 type Connection = [number, number];
 const kNodeTypeObjectMap = {
   [synapse.NodeType.kBroadbandSource]: BroadbandSource,
+  [synapse.NodeType.kDiskWriter]: DiskWriter,
   [synapse.NodeType.kElectricalStimulation]: ElectricalStimulation,
   [synapse.NodeType.kSpikeSource]: SpikeSource,
   [synapse.NodeType.kOpticalStimulation]: OpticalStimulation,

package/src/demo.ts

@@ -11,15 +11,17 @@ import StreamIn from "./nodes/stream_in";
 import StreamOut from "./nodes/stream_out";
 import { discover } from "./utils/discover";
 import { getName } from "./utils/enum";
+import { getClientIp } from "./utils/ip";
 
 const cli = yargs(hideBin(process.argv))
   .help()
   .command("discover", "Discover synapse devices")
   .command("read", "Read from StreamOut node", {
-    "multicast-group": {
-      alias: "m",
+    "udp-port": {
+      alias: "p",
       type: "string",
-      description: "Multicast group",
+      description: "UDP port",
+      default: "50038",
     },
     output: {
       alias: "o",
@@ -93,7 +95,7 @@ const info = async (device: Device) => {
 const read = async (device: Device, argv: any) => {
   console.log("Reading from device's StreamOut node...");
 
-  const { multicastGroup, output } = argv;
+  const { udpPort, output } = argv;
   let status = null;
   let stream = null;
   if (output) {
@@ -111,7 +113,7 @@ const read = async (device: Device, argv: any) => {
 
   const config = new Config();
   const nodeEphys = new ElectricalBroadband({
-    peripheralId: 3,
+    peripheralId: 100,
     signal: {
       electrode: {
         channels: [{ id: 0, referenceId: 0, electrodeId: 1 }],
@@ -122,9 +124,12 @@ const read = async (device: Device, argv: any) => {
   });
   const nodeStreamOut = new StreamOut(
     {
-      multicastGroup,
+      udpUnicast: {
+        destinationPort: udpPort,
+        destinationAddress: await getClientIp(),
+      },
     },
-    onMessage
+    { onMessage }
   );
 
   status = config.add([nodeEphys, nodeStreamOut]);
@@ -148,7 +153,11 @@ const read = async (device: Device, argv: any) => {
     return;
   }
 
-  nodeStreamOut.start();
+  status = await nodeStreamOut.start();
+  if (!status.ok()) {
+    console.error("failed to start stream out node: ", status.message);
+    return;
+  }
 
   let running = true;
   process.on("SIGINT", function () {
@@ -159,6 +168,7 @@ const read = async (device: Device, argv: any) => {
     running = false;
     nodeStreamOut.stop();
     device.stop();
+    process.exit();
   });
 };
 
@@ -280,7 +290,9 @@ const main = async () => {
   if (argv._.includes("discover")) {
     const devices = await discover();
     for (const device of devices) {
-      console.log(`${device.host}:${device.port}   ${device.capability}   ${device.name} (${device.serial})`);
+      const addr = `${device.host}:${device.port}`;
+      const serial = `[${device.serial}]`;
+      console.log(`${addr.padEnd(21)} ${device.capability.padStart(16)} ${serial.padStart(34)} "${device.name}"`);
     }
     return;
   }

package/src/nodes/disk_writer.ts

@@ -0,0 +1,30 @@
+import { synapse } from "../api/api";
+import Node from "../node";
+
+class DiskWriter extends Node {
+  type = synapse.NodeType.kDiskWriter;
+  config: synapse.IDiskWriterConfig;
+
+  constructor(config: synapse.IDiskWriterConfig = {}) {
+    super();
+
+    this.config = config;
+  }
+
+  toProto(): synapse.NodeConfig {
+    return super.toProto({
+      diskWriter: this.config,
+    });
+  }
+
+  static fromProto(proto: synapse.INodeConfig): DiskWriter {
+    const { diskWriter } = proto;
+    if (!diskWriter) {
+      throw new Error("Invalid config, missing diskWriter");
+    }
+
+    return new DiskWriter(proto.diskWriter);
+  }
+}
+
+export default DiskWriter;

package/src/nodes/index.ts

@@ -1,4 +1,5 @@
 export { default as BroadbandSource } from "./broadband_source";
+export { default as DiskWriter } from "./disk_writer";
 export { default as ElectricalStimulation } from "./electrical_stimulation";
 export { default as OpticalStimulation } from "./optical_stimulation";
 export { default as SpectralFilter } from "./spectral_filter";