RASCSI/src/raspberrypi/rascsi_interface.proto

syntax = "proto3";

package rascsi_interface;

// The supported device types
enum PbDeviceType {
    UNDEFINED = 0;
    SASI_HD = 1;
    SCSI_HD = 2;
    MO = 3;
    CD = 4;
    BR = 5;
    NUVOLINK = 6;
    DAYNAPORT = 7;
}

// rascsi remote operations
enum PbOperation {
    NONE = 0;
    // Returns the full server information
    SERVER_INFO = 1;
    // Returns the device list only (required for rasctl/logging semantics compatibility)
    LIST = 2 [deprecated = true];
    LOG_LEVEL = 3;
    ATTACH = 4;
    DETACH = 5;
    INSERT = 6;
    EJECT = 7;
    PROTECT = 8;
    UNPROTECT = 9;
}

// Commands rascsi can execute
message PbCommand {
    PbOperation cmd = 1;
    int32 id = 2;
    int32 un = 3;
    PbDeviceType type = 4;
    string params = 5;
}

// The result of a command
message PbResult {
    bool status = 1;
    string msg = 2;
}

// The device meta data
message PbDevice {
    int32 id = 1;
    int32 un = 2;
    PbDeviceType type = 3;
    string file = 4;
    bool read_only = 5;
    // Note: Read-only media (e.g. CD-ROMs) are not protectable
    bool protectable = 6;
    // Note: Read-only media (e.g. CD-ROMs) are not protected but just read-only
    bool protected = 7;
    bool removable = 8;
    bool removed = 9;
    bool lockable = 10;
    bool locked = 11;
    bool supports_file = 12;
}

message PbDevices {
    repeated PbDevice devices = 1;
}

// The rascsi server information
message PbServerInfo {
    string rascsi_version = 1;
    // Sorted by severity
    repeated string available_log_levels = 2;
    string current_log_level = 3;
    string default_image_folder = 4;
    // Files in the default folder
    repeated string available_image_files = 5;
    // The attached devices
    PbDevices devices = 6;
}