@blueid/access-proto 0.13.0

package/BlueLock.proto

@@ -0,0 +1,35 @@
+syntax = "proto2";
+
+import "BlueCore.proto";
+
+import "nanopb.proto";
+
+enum BlueLockState {
+  UnknownLockState = 1;
+  Locked = 2;
+  Unlocked = 3;
+  Jammed = 4;
+}
+
+message BlueLockConfig {
+  // Schedules for when the lock opens automatically
+  repeated BlueLocalTimeSchedule openSchedules = 1 [ (nanopb).max_count = 4 ];
+
+  // If set to true then the lock opens by schedule only after it was first
+  // opened by an authenticated user and is within any of the open schedules
+  required bool openScheduleByUser = 2 [ default = false ];
+
+  // Days of year (1-366) the open schedule is ignored (ie vacation days)
+  repeated uint32 closedDays = 20 [ (nanopb).max_count = 18 ];
+
+  // Default time in seconds to keep the lock open
+  required uint32 defaultOpenTimeSec = 21 [ default = 5 ];
+
+  // Extended time in seconds to keep the lock open
+  required uint32 extendedOpenTimeSec = 22 [ default = 3600 ];
+}
+
+message BlueLockStatus {
+  required BlueLockState state = 1;
+  required uint32 openings = 2;
+}

package/BlueSDK.proto

@@ -0,0 +1,56 @@
+syntax = "proto2";
+
+// import "nanopb.proto";
+
+import "BlueCore.proto";
+
+///////////////////////////////////////////////////////////////////////
+// I18n
+///////////////////////////////////////////////////////////////////////
+
+message BlueI18n {
+  required string nfcWaitMessage = 1 [ default = "Waiting for transponder" ];
+  required string nfcOssSuccessReadConfigurationMessage = 2
+      [ default = "Configuration read successfully" ];
+  required string nfcOssSuccessUpdateConfigurationMessage = 3
+      [ default = "Configuration successfully updated" ];
+  required string nfcOssSuccessClearEventsMessage = 4
+      [ default = "Events successfully cleared" ];
+  required string nfcOssSuccessIsProvisionedMessage = 5
+      [ default = "Is already provisioned" ];
+  required string nfcOssSuccessProvisionMessage = 6
+      [ default = "Successfully provisioned" ];
+  required string nfcOssSuccessUnprovisionMessage = 7
+      [ default = "Successfully unprovisioned" ];
+  required string nfcOssSuccessFormatMessage = 8
+      [ default = "Transponder was successfully formatted" ];
+}
+
+///////////////////////////////////////////////////////////////////////
+// Device
+///////////////////////////////////////////////////////////////////////
+
+enum BlueDeviceType {
+  BluetoothDevice = 1;
+  UWBDevice = 2;
+}
+
+message BlueDeviceDetailsBluetooth {
+  required int32 rssi = 1;
+  required int32 txPower = 2;
+  required bool isIBeacon = 3;
+}
+
+message BlueDeviceDetailsUWB { required bool notUsed = 1; }
+
+message BlueDeviceInfo {
+  required BlueDeviceType deviceType = 1;
+  required string deviceId = 2;
+  required float distanceMeters = 3;
+  optional BlueBleManufacturerInfo manufacturerInfo = 4;
+
+  oneof details {
+    BlueDeviceDetailsBluetooth bluetooth = 5;
+    BlueDeviceDetailsUWB uwb = 6;
+  }
+}

package/BlueSystem.proto

@@ -0,0 +1,278 @@
+syntax = "proto2";
+
+import "BlueCore.proto";
+import "BlueLock.proto";
+
+import "nanopb.proto";
+
+///////////////////////////////////////////////////////////////////////
+// System types
+///////////////////////////////////////////////////////////////////////
+
+message BlueTimeOffsetPeriod {
+  // UTC-epoch when this shift occurs
+  required uint32 epoch = 1;
+  // The time offset in minutes, negative or positive
+  required int32 offset = 2;
+}
+
+message BlueBaseConfig {
+  // The time offsets that get shifted automatically
+  repeated BlueTimeOffsetPeriod timeOffsetPeriods = 1
+      [ (nanopb).max_count = 12 ];
+
+  // If enabled this will check the system-status every 24-hours and
+  // react accordingly ie like when battery is running low opening the lock
+  // and logging accordingly etc
+  required bool autoCheckSystemStatus = 2 [ default = false ];
+}
+
+message BlueBleConfig {
+  // Whether ble is enabled or not
+  required bool isAdvertising = 1 [ default = true ];
+
+  // Optional schedule on when ble advertising is enabled, if none
+  // set then ble is always on when enabled
+  repeated BlueLocalTimeSchedule advertisingSchedules = 2
+      [ (nanopb).max_count = 8 ];
+
+  // Index of advertising schedules (starting at zero) where it should
+  // use the max power level available for broader reach
+  repeated uint32 maxPowerAdvertisingSchedulesIndices = 3
+      [ (nanopb).max_count = 4 ];
+
+  // The desired advertising interval in ms
+  required uint32 advertisingIntervalMs = 4 [ default = 500 ];
+
+  // The maximal connection timeout per connection in milliseconds
+  required uint32 maxConnectionTimeoutMs = 5 [ default = 3000 ];
+
+  // The actual tx power level used for bluetooth from (0 - lowest) to 7
+  // (highest)
+  required uint32 txPowerLevel = 6 [ default = 3 ];
+
+  // The advertised tx power level at 1 meter in decibel (-XX - +XX)
+  required int32 advertisedTxPower1Meter = 7 [ default = -77 ];
+
+  // If set then advertises as IBeacon otherwise uses regular advertising
+  required bool isIBeaconAdvertisement = 8;
+}
+
+enum BlueOnlineMode {
+  // Offline mode
+  OfflineMode = 0;
+  // Wifi is manually re-connected whenever required
+  ManualWifi = 1;
+  // Wifi is always connected and re-connects automatically
+  AlwaysOnWifi = 2;
+  // A LAN connection is available that shall be used
+  UseLan = 3;
+}
+
+message BlueOnlineConfig {
+  // The online mode
+  required BlueOnlineMode mode = 1 [ default = OfflineMode ];
+
+  // Schedules when it should go online for updating. Only takes effect if
+  // online mode is set to manual wifi. The end time is not used.
+  repeated BlueLocalTimeSchedule connectSchedules = 2
+      [ (nanopb).max_count = 4 ];
+
+  // The SSID of the wifi network
+  required string wifiSSID = 3 [ (nanopb).max_length = 32 ];
+
+  // The wifi password
+  required string wifiPassword = 4 [ (nanopb).max_length = 32 ];
+
+  // Default timeout for online connections
+  required uint32 timeoutSec = 5 [ default = 30 ];
+}
+
+message BlueAccessConfig {
+  // The device's unique access id
+  required uint32 id = 1 [ default = 1 ];
+
+  // The site id bound to this device
+  required uint32 siteId = 2 [ default = 1 ];
+
+  // The access groups this device is part of
+  repeated uint32 groupIds = 3 [ (nanopb).max_count = 16 ];
+}
+
+message BlueOssConfig {
+  //
+  // -- Oss SecureId --
+  //
+
+  // The mifare aes-key for reading the oss secure id application, default is
+  // the oss sid demo key
+  required bytes sidMifareAesKey = 1 [
+    (nanopb).max_size = 16,
+    (nanopb).fixed_length = true,
+    default = "\xFF\xEE\xDD\xCC\xBB\xAA\x99\x88\x77\x66\x55\x44\x33\x22\x11\x00"
+  ];
+
+  // The mifare application id for the oss secure id application, default is the
+  // oss sid default aid. A value of 0 disables Oss Sid Mifare support.
+  required uint32 sidMifareAid = 2 [ default = 16076801 ];
+
+  //
+  // -- Oss Offline --
+  //
+
+  // If set the system will try to connect online to refresh the presented oss
+  // offline card if required as well as it will try to get and put the latest
+  // blacklist on the card
+  required bool soUpdater = 3 [ default = false ];
+
+  // If set the system will try to connect online if there are any events on a
+  // presented card and transfer all events online
+  required bool soPushEvents = 4 [ default = false ];
+
+  // If set the system will transfer pending events to an offline card
+  required bool soWritePendingEvents = 5 [ default = true ];
+
+  // If set the system will update from the blacklist of an offline card
+  required bool soUpdateFromBlacklist = 6 [ default = true ];
+
+  // The mifare aes-key for reading/writing the oss offline application, default
+  // is the oss so demo key
+  required bytes soMifareAesKey = 7 [
+    (nanopb).max_size = 16,
+    (nanopb).fixed_length = true,
+    default = "\x10\x11\x12\x13\x14\x15\x16\x17\x18\x19\x1A\x1B\x1C\x1D\x1E\x1F"
+  ];
+
+  // The mifare application id for the oss offline application, default is the
+  // oss so default aid. A value of 0 disables Oss So Mifare support.
+  required uint32 soMifareAid = 8 [ default = 16076800 ];
+}
+
+message BlueSystemConfig {
+  required uint32 version = 1;
+  // -- Base
+  required BlueBaseConfig base = 2;
+  required BlueBleConfig ble = 3;
+  required BlueOnlineConfig online = 4;
+  required BlueAccessConfig access = 5;
+  required BlueOssConfig oss = 6;
+  // -- Custom
+  optional BlueLockConfig lock = 7;
+}
+
+message BlueSystemTimeUnix { required uint32 epoch = 1; }
+
+message BlueSystemUpdate {
+  optional BlueSystemConfig config = 1;
+  optional BlueSystemTimeUnix timeUnix = 2;
+}
+
+message BlueSystemSettings {
+  required uint32 blacklistMaxEntriesCount = 1 [ default = 0 ];
+  required uint32 blacklistEntriesCount = 2 [ default = 0 ];
+
+  required uint32 eventLogMaxEntriesCount = 3 [ default = 0 ];
+  required uint32 eventLogEntriesCount = 4 [ default = 0 ];
+  required uint32 eventLogSequenceId = 5 [ default = 0 ];
+  required uint32 eventLogIndex = 6 [ default = 0 ];
+
+  required uint32 systemLogMaxEntriesCount = 7 [ default = 0 ];
+  required uint32 systemLogEntriesCount = 8 [ default = 0 ];
+  required uint32 systemLogSequenceId = 9 [ default = 0 ];
+  required uint32 systemLogIndex = 10 [ default = 0 ];
+
+  required bool timeWasSet = 11;
+
+  required bool isBatteryLow = 12;
+}
+
+message BlueSystemProvisioning {
+  required BlueHardwareType hardwareType = 1 [ default = TestHardware ];
+  // Unique id generated by blueid which identitifies this device (default set
+  // from BlueSharedDemoKeys)
+  required string deviceId = 2 [ (nanopb).max_length = 8 ];
+  // Serial-number which is vendor specific stored as hex
+  required string serialNumber = 3
+      [ (nanopb).max_length = 20, default = "00000000000000000000" ];
+  // Private key used for signing to proof authenticity of this device (default
+  // set from BlueSharedDemoKeys)
+  required bytes terminalPrivateKey = 4 [ (nanopb).max_size = 160 ];
+  // Public key used for verifying signatures being valid on this device
+  // (default set from BlueSharedDemoKeys)
+  required bytes signaturePublicKey = 5 [ (nanopb).max_size = 100 ];
+}
+
+message BlueSystemStatus {
+  required uint32 configVersion = 1;
+  required string deviceId = 2 [ (nanopb).max_length = 8 ];
+  required string serialNumber = 3 [ (nanopb).max_length = 20 ];
+  required BlueHardwareType hardwareType = 4;
+  required BlueBatteryLevel batteryLevel = 5;
+  required uint32 applicationVersion = 6;
+  required BlueLocalTimestamp localTime = 7;
+  required BlueSystemSettings settings = 8;
+  required uint32 blacklistEntriesCount = 9;
+  required uint32 eventLogEntriesCount = 10;
+  required uint32 eventLogSequenceId = 11;
+  required uint32 systemLogEntriesCount = 12;
+  required uint32 systemLogSequenceId = 13;
+
+  // -- Custom
+  optional BlueLockStatus lock = 14;
+}
+
+///////////////////////////////////////////////////////////////////////
+// System Log
+///////////////////////////////////////////////////////////////////////
+
+message BlueSystemLogQuery {
+  required uint32 maxCount = 1;
+
+  oneof start {
+    uint32 sequenceId = 2;
+    bool fromHead = 3; // false = starts from tail
+  }
+}
+
+message BlueSystemLogEntry {
+  required uint32 sequenceId = 1;
+
+  required BlueLocalTimestamp time = 2;
+
+  required uint32 severity = 3;
+
+  required uint32 line = 4;
+
+  required string file = 5 [ (nanopb).max_length = 20 ];
+
+  required string message = 6 [ (nanopb).max_length = 94 ];
+}
+
+message BlueSystemLogResult {
+  repeated BlueSystemLogEntry entries = 1 [ (nanopb).max_count = 10 ];
+}
+
+///////////////////////////////////////////////////////////////////////
+// Event Log
+///////////////////////////////////////////////////////////////////////
+
+message BlueEventLogQuery {
+  required uint32 maxCount = 1;
+
+  oneof start {
+    uint32 sequenceId = 2;
+    bool fromHead = 3; // false = starts from tail
+  }
+}
+
+message BlueEventLogResult {
+  repeated BlueEvent events = 1 [ (nanopb).max_count = 50 ];
+}
+
+///////////////////////////////////////////////////////////////////////
+// Blacklist
+///////////////////////////////////////////////////////////////////////
+
+message BlueBlacklistEntries {
+  repeated BlueBlacklistEntry entries = 1 [ (nanopb).max_count = 75 ];
+}