kinokero 0.0.5

data/lib/proto/input_tray_unit.proto

@@ -0,0 +1,35 @@
+// Physical model of a printer input tray.
+
+import 'localized_string.proto';
+
+message InputTrayUnit {
+  // Enumeration of input tray types.
+  enum Type {
+    CUSTOM = 0;
+    INPUT_TRAY = 1;
+    BYPASS_TRAY = 2;
+    MANUAL_FEED_TRAY = 3;
+    LCT = 4;  // Large capacity tray.
+    ENVELOPE_TRAY = 5;
+    ROLL = 6;
+  }
+
+  // Vendor-provided ID of the input tray (required).
+  optional string vendor_id = 1;
+
+  // Type of input tray (required).
+  optional Type type = 2;
+
+  // Index of the input tray.
+  optional int64 index = 3;
+
+  // Non-localized custom display name of the input tray.
+  // New CDDs should use custom_display_name_localized instead. It is required
+  // that either custom_display_name or custom_display_name_localized is set if
+  // the tray's type is CUSTOM.
+  optional string custom_display_name = 4;
+
+  // Translations of custom display name of the input tray.
+  // If not empty, must contain an entry with locale == EN.
+  repeated LocalizedString custom_display_name_localized = 5;
+}

data/lib/proto/job_state.proto

@@ -0,0 +1,143 @@
+// Contains the device-agnostic state of a job on a cloud device.
+message JobState {
+
+  // Supported job state types.
+  enum Type {
+
+    // Job is being created and is not ready for processing yet.
+    DRAFT = 0;
+
+    // Submitted and ready, but should not be processed yet.
+    HELD = 1;
+
+    // Ready for processing.
+    QUEUED = 2;
+
+    // Currently being processed.
+    IN_PROGRESS = 3;
+
+    // Was in progress, but stopped due to error or user intervention.
+    STOPPED = 4;
+
+    // Processed successfully.
+    DONE = 5;
+
+    // Aborted due to error or by user action (cancelled).
+    ABORTED = 6;
+  }
+
+  message UserActionCause {
+
+    // Next number = 2.
+    enum ActionCode {
+      // User has cancelled the job.
+      CANCELLED = 0;
+      // User has paused the job.
+      PAUSED = 1;
+      // User has performed some other action.
+      OTHER = 100;
+    }
+
+    // Code for the user action which caused the current job state (required).
+    optional ActionCode action_code = 1;
+  }
+
+  message DeviceStateCause {
+
+    // Next number = 5.
+    enum ErrorCode {
+      // Error due to input tray problem.
+      INPUT_TRAY = 0;
+      // Error due to marker problem.
+      MARKER = 1;
+      // Error due to a problem in the media path.
+      MEDIA_PATH = 2;
+      // Error due to media size problem.
+      MEDIA_SIZE = 3;
+      // Error due to media type problem.
+      MEDIA_TYPE = 4;
+      // Error due to some other device state.
+      OTHER = 100;
+    }
+
+    // Error code for the device state which caused the current job state
+    // (required).
+    optional ErrorCode error_code = 1;
+  }
+
+  message DeviceActionCause {
+
+    // Next number = 3.
+    enum ErrorCode {
+      // Error while downloading job.
+      DOWNLOAD_FAILURE = 0;
+      // Error due to invalid job ticket.
+      INVALID_TICKET = 1;
+      // A generic printing error occurred.
+      PRINT_FAILURE = 2;
+      // Error due to some other device action.
+      OTHER = 100;
+    }
+
+    // Error code for the device action which caused the current job state
+    // (required).
+    optional ErrorCode error_code = 1;
+  }
+
+  message ServiceActionCause {
+
+    // Next number = 16.
+    enum ErrorCode {
+      COMMUNICATION_WITH_DEVICE_ERROR = 0;
+      CONVERSION_ERROR = 1;
+      CONVERSION_FILE_TOO_BIG = 2;
+      CONVERSION_UNSUPPORTED_CONTENT_TYPE = 3;
+      DELIVERY_FAILURE = 11;
+      EXPIRATION = 14;
+      FETCH_DOCUMENT_FORBIDDEN = 4;
+      FETCH_DOCUMENT_NOT_FOUND = 5;
+      GOOGLE_DRIVE_QUOTA = 15;
+      INCONSISTENT_JOB = 6;
+      INCONSISTENT_PRINTER = 13;
+      PRINTER_DELETED = 12;
+      REMOTE_JOB_NO_LONGER_EXISTS = 7;
+      REMOTE_JOB_ERROR = 8;
+      REMOTE_JOB_TIMEOUT = 9;
+      REMOTE_JOB_ABORTED = 10;
+      OTHER = 100;
+    }
+
+    // Error code for the service action which caused the current job state
+    // (required).
+    optional ErrorCode error_code = 1;
+  }
+
+  // Current job state type (required).
+  optional Type type = 1;
+
+  // Exactly one of the following four fields must be set if and only if the
+  // state type is ABORTED or STOPPED.
+  // For example:
+  // - {"type": "ABORTED", "user_action_cause": {"action_code": "CANCELLED"}}
+  //   interpreted as the job was cancelled by the user.
+  // - {"type": "STOPPED", "device_state_cause": {"error_code": "MEDIA_PATH"}}
+  //   interpreted as the job was stopped due to a temporary problem with the
+  //   media path, such as paper jam (the specific cause will be discerned from
+  //   the device state by the server).
+  // - {"type": "ABORTED",
+  //    "device_action_cause": {"error_code": "DOWNLOAD_FAILURE"}}
+  //   interpreted as the job was aborted due to a download failure.
+
+  // If present, job state was changed due to user action.
+  optional UserActionCause user_action_cause = 2;
+
+  // If present, job state was changed due to device state change.
+  optional DeviceStateCause device_state_cause = 3;
+
+  // If present, job state was changed due to device action.
+  optional DeviceActionCause device_action_cause = 4;
+
+  // If present, job state was changed due to service (Cloud Print) action.
+  // Should only be set by the Cloud Print server.
+  optional ServiceActionCause service_action_cause = 5;
+}

data/lib/proto/local_settings.proto

@@ -0,0 +1,36 @@
+// Contains current and pending local settings.
+message LocalSettings {
+
+  // Contains settings that do not change with normal use of the device.
+  message Settings {
+
+    // Whether Privet local discovery is enabled (required).
+    optional bool local_discovery = 1;
+
+    // Whether Privet access token API should be exposed on the local network.
+    optional bool access_token_enabled = 2;
+
+    // Whether Privet local printing API should be exposed on the local network.
+    optional bool printer/local_printing_enabled = 3;
+
+    // Whether Privet local printing may send jobs to the server for conversion.
+    optional bool printer/conversion_printing_enabled = 4;
+
+    // Number of seconds between XMPP channel pings.
+    optional int32 xmpp_timeout_value = 5;
+  }
+
+  // Current local settings.
+  // Required (for GCP 2.0) to be provided by the device via the /register
+  // interface. Should be provided or confirmed by the device via the /update
+  // interface as necessary. Prohibited to be provided by clients. Always
+  // present in the local_settings field returned by the /printer interface.
+  optional Settings current = 1;
+
+  // Pending local settings.
+  // Prohibited to be provided by the device. Provided by clients via the
+  // /update interface. Present in the local_settings field returned by the
+  // /printer interface if a client has provided pending local settings but the
+  // device has not yet confirmed them as current.
+  optional Settings pending = 2;
+}

data/lib/proto/localized_string.proto

@@ -0,0 +1,119 @@
+// A localized human-readable string translated to a specific locale.
+// It is recommended to include translations of custom strings only for locales
+// for which significant use of the device can be expected. If the translation
+// of a custom string for a user's language and country (e.g. ZH_TW) is not
+// present, GCP will display the translation for the base language (e.g. ZH).
+// If neither translation is present, the translation for EN (which is required
+// in every list of localized strings) will be displayed.
+message LocalizedString {
+  // Locale that the string is translated to (required).
+  optional Locale locale = 1;
+  // Translated content of the string (required).
+  optional string value = 2;
+
+  enum Locale {
+    AF = 0;
+    AM = 1;
+    AR = 2;
+    AR_XB = 3;
+    BG = 4;
+    BN = 5;
+    CA = 6;
+    CS = 7;
+    CY = 8;
+    DA = 9;
+    DE = 10;
+    DE_AT = 11;
+    DE_CH = 12;
+    EL = 13;
+    EN = 14;
+    EN_GB = 15;
+    EN_IE = 16;
+    EN_IN = 17;
+    EN_SG = 18;
+    EN_XA = 19;
+    EN_XC = 20;
+    EN_ZA = 21;
+    ES = 22;
+    ES_419 = 23;
+    ES_AR = 24;
+    ES_BO = 25;
+    ES_CL = 26;
+    ES_CO = 27;
+    ES_CR = 28;
+    ES_DO = 29;
+    ES_EC = 30;
+    ES_GT = 31;
+    ES_HN = 32;
+    ES_MX = 33;
+    ES_NI = 34;
+    ES_PA = 35;
+    ES_PE = 36;
+    ES_PR = 37;
+    ES_PY = 38;
+    ES_SV = 39;
+    ES_US = 40;
+    ES_UY = 41;
+    ES_VE = 42;
+    ET = 43;
+    EU = 44;
+    FA = 45;
+    FI = 46;
+    FR = 47;
+    FR_CA = 48;
+    FR_CH = 49;
+    GL = 50;
+    GU = 51;
+    HE = 52;
+    HI = 53;
+    HR = 54;
+    HU = 55;
+    HY = 56;
+    ID = 57;
+    IN = 58;
+    IT = 59;
+    JA = 60;
+    KA = 61;
+    KM = 62;
+    KN = 63;
+    KO = 64;
+    LN = 65;
+    LO = 66;
+    LT = 67;
+    LV = 68;
+    ML = 69;
+    MO = 70;
+    MR = 71;
+    MS = 72;
+    NB = 73;
+    NE = 74;
+    NL = 75;
+    NO = 76;
+    PL = 77;
+    PT = 78;
+    PT_BR = 79;
+    PT_PT = 80;
+    RM = 81;
+    RO = 82;
+    RU = 83;
+    SK = 84;
+    SL = 85;
+    SR = 86;
+    SR_LATN = 87;
+    SV = 88;
+    SW = 89;
+    TA = 90;
+    TE = 91;
+    TH = 92;
+    TL = 93;
+    TR = 94;
+    UK = 95;
+    UR = 96;
+    VI = 97;
+    ZH = 98;
+    ZH_CN = 99;
+    ZH_HK = 100;
+    ZH_TW = 101;
+    ZU = 102;
+  }
+}

data/lib/proto/margins.proto

@@ -0,0 +1,33 @@
+// Capability that defines the margins available on a device (including a custom
+// one). Margins are measured in microns.
+message Margins {
+  // Enumerates the set of predefined types of margins. Devices should use these
+  // types to semantically describe the margins option. This type will be used
+  // for UI purposes only.
+  enum Type {
+    BORDERLESS = 0;
+    STANDARD = 1;
+    CUSTOM = 2;
+  }
+
+  message Option {
+    // Type of margin option (required).
+    optional Type type = 1;
+
+    // Top margin of the page (required).
+    optional int32 top_microns = 2;
+
+    // Right margin of the page (required).
+    optional int32 right_microns = 3;
+
+    // Bottom margin of the page (required).
+    optional int32 bottom_microns = 4;
+
+    // Left margin of the page (required).
+    optional int32 left_microns = 5;
+
+    optional bool is_default = 6 [default = false];
+  }
+
+  repeated Option option = 1;
+}

data/lib/proto/margins_ticket_item.proto

@@ -0,0 +1,14 @@
+// Ticket item indicating what margins to use (in microns).
+message MarginsTicketItem {
+  // Top margin of the page (required).
+  optional int32 top_microns = 1;
+
+  // Top margin of the page (required).
+  optional int32 right_microns = 2;
+
+  // Top margin of the page (required).
+  optional int32 bottom_microns = 3;
+
+  // Top margin of the page (required).
+  optional int32 left_microns = 4;
+}

data/lib/proto/marker.proto

@@ -0,0 +1,62 @@
+// Physical model of a printer marker.
+
+import 'localized_string.proto';
+
+message Marker {
+  // Enumeration of types of printer markers.
+  enum Type {
+    CUSTOM = 0;
+    TONER = 1;
+    INK = 2;
+    STAPLES = 3;
+  }
+
+  // Message that describes the color of a marker.
+  message Color {
+    // Enumeration of color types of the printer marker.
+    enum Type {
+      CUSTOM = 0;
+      BLACK = 1;
+      COLOR = 2;
+      CYAN = 3;
+      MAGENTA = 4;
+      YELLOW = 5;
+      LIGHT_CYAN = 6;
+      LIGHT_MAGENTA = 7;
+      GRAY = 8;
+      LIGHT_GRAY = 9;
+    }
+
+    // Required.
+    optional Type type = 1;
+
+    // Non-localized custom display name of the color.
+    // New CDDs should use custom_display_name_localized instead. It is required
+    // that either custom_display_name or custom_display_name_localized is set
+    // if the color's type is CUSTOM.
+    optional string custom_display_name = 2;
+
+    // Translations of custom display name of the color.
+    // If not empty, must contain an entry with locale == EN.
+    repeated LocalizedString custom_display_name_localized = 3;
+  }
+
+  // Vendor-provided ID of the marker (required).
+  optional string vendor_id = 1;
+
+  // Type of marker (required).
+  optional Type type = 2;
+
+  // Color of the marker. Only needed if marker type is INK or TONER.
+  optional Color color = 3;
+
+  // Non-localized custom display name of the marker.
+  // New CDDs should use custom_display_name_localized instead. It is required
+  // that either custom_display_name or custom_display_name_localized is set
+  // if the marker's type is CUSTOM.
+  optional string custom_display_name = 4;
+
+  // Translations of custom display name of the marker.
+  // If not empty, must contain an entry with locale == EN.
+  repeated LocalizedString custom_display_name_localized = 5;
+}