signal.proto

syntax = "proto3";

import "types.proto";

package mirabuf.signal;

/**
 * Signals is a container for all of the potential signals.
 */
 message Signals {
    Info info = 1;  /// Has identifiable data (id, name, version)
    map<string, Signal> signal_map = 2; /// Contains a full collection of symbols
}

/**
 * IOType is a way to specify Input or Output.
 * 
 */
enum IOType {
    INPUT = 0;  /// Input Signal
    OUTPUT = 1; /// Output Signal
}

/**
 * DeviceType needs to be a type of device that has a supported connection
 * As well as a signal frmae but that can come later
 */
enum DeviceType {
    PWM = 0;
    Digital = 1;
    Analog = 2;
    I2C = 3;
    CANBUS = 4;
    CUSTOM = 5;
}

/**
 * Signal is a way to define a controlling signal.
 * 
 * TODO: Add Origin
 * TODO: Decide how this is linked to a exported object
 */
message Signal {
    Info info = 1;  /// Has identifiable data (id, name, version)
    IOType io = 2;  /// Is this a Input or Output
    string custom_type = 3; /// The name of a custom input type that is not listed as a device type
    uint32 signal_id = 4;   /// ID for a given signal that exists... PWM 2, CANBUS 4
    DeviceType device_type = 5; /// Enum for device type that should always be set
}