@blueid/access-proto 0.19.0 → 0.22.0

package/BlueCore.proto

@@ -178,23 +178,23 @@ enum BlueReturnCode {
 
 message BlueVersionInfo {
   required uint32 buildTime = 1;
-  required uint32 version = 2;
+  required uint32 version = 2 [ (nanopb).int_size = IS_16 ];
 }
 
 message BlueLocalTimestamp {
-  required uint32 year = 1;
-  required uint32 month = 2;
-  required uint32 date = 3;
-  required uint32 hours = 4;
-  required uint32 minutes = 5;
-  required uint32 seconds = 6 [ default = 0 ];
+  required uint32 year = 1 [ (nanopb).int_size = IS_16 ];
+  required uint32 month = 2 [ (nanopb).int_size = IS_8 ];
+  required uint32 date = 3 [ (nanopb).int_size = IS_8 ];
+  required uint32 hours = 4 [ (nanopb).int_size = IS_8 ];
+  required uint32 minutes = 5 [ (nanopb).int_size = IS_8 ];
+  required uint32 seconds = 6 [ (nanopb).int_size = IS_8, default = 0 ];
 }
 
 message BlueLocalTimeperiod {
-  required uint32 hoursFrom = 1;
-  required uint32 minutesFrom = 2;
-  required uint32 hoursTo = 3;
-  required uint32 minutesTo = 4;
+  required uint32 hoursFrom = 1 [ (nanopb).int_size = IS_8 ];
+  required uint32 minutesFrom = 2 [ (nanopb).int_size = IS_8 ];
+  required uint32 hoursTo = 3 [ (nanopb).int_size = IS_8 ];
+  required uint32 minutesTo = 4 [ (nanopb).int_size = IS_8 ];
 }
 
 enum BlueTimeUnit {
@@ -219,11 +219,11 @@ enum BlueWeekday {
 
 message BlueLocalTimeSchedule {
   // Day of year is always 1-366, to spawn whole year make 1->366
-  required uint32 dayOfYearStart = 1;
-  required uint32 dayOfYearEnd = 2;
+  required uint32 dayOfYearStart = 1 [ (nanopb).int_size = IS_16 ];
+  required uint32 dayOfYearEnd = 2 [ (nanopb).int_size = IS_16 ];
   // See BlueWeekday -> byte 0 = Monday, etc.
-  required bytes weekdays = 3
-      [ (nanopb).max_size = 7, (nanopb).fixed_length = true ];
+  repeated bool weekdays = 3
+      [ (nanopb).max_count = 7, (nanopb).fixed_length = true ];
   required BlueLocalTimeperiod timePeriod = 4;
 }
 
@@ -285,15 +285,16 @@ enum BlueBatteryLevel {
 message BlueBleManufacturerInfo {
   required BlueHardwareType hardwareType = 1;
   required BlueBatteryLevel batteryLevel = 2;
-  required uint32 applicationVersion = 3;
+  required uint32 applicationVersion = 3 [ (nanopb).int_size = IS_16 ];
   required uint32 localMidnightTimeEpoch = 4;
+  required bool isFactory = 5;
 }
 
 message BlueBleAdvertisementInfo {
   // Unique device id becomes the local name
   required string deviceId = 1 [ (nanopb).max_length = 8 ];
   // The advertised tx power level at 1 meter in decibel (-XX - +XX)
-  required int32 txPower1Meter = 2;
+  required int32 txPower1Meter = 2 [ (nanopb).int_size = IS_8 ];
   // If set generates iBeacon format otherwise generates regular ble adv data
   required bool isIBeacon = 3;
   // The manufacturer information
@@ -416,7 +417,7 @@ message BlueSPHandshakeReply {
   required bytes terminalSignature = 2 [ (nanopb).max_size = 74 ];
 }
 
-message BlueSPDataCommand {
+message BlueSPTokenCommand {
   required BlueCredentialId credentialId = 1;
   required BlueLocalTimestamp validityStart = 2;
   required BlueLocalTimestamp validityEnd = 3;
@@ -425,11 +426,11 @@ message BlueSPDataCommand {
       [ (nanopb).max_size = 1792 ]; // we'll add 256b for add. data
 }
 
-message BlueSPData {
+message BlueSPToken {
   required bytes signature = 1 [ (nanopb).max_size = 74 ];
 
   oneof payload {
-    BlueSPDataCommand command = 2;
+    BlueSPTokenCommand command = 2;
     BlueOssSoMobile ossSo = 3;
     BlueOssSidMobile ossSid = 4;
   }
@@ -604,9 +605,9 @@ message BlueOssSoCredentialType {
 }
 
 message BlueOssSoDTScheduleDay {
-  // 0  = Monday -> 6 = Sunday (Matches BlueWeekday)
-  repeated bool weekdays = 1
-      [ (nanopb).max_count = 7, (nanopb).fixed_count = true ];
+  // See BlueWeekday -> byte 0 = Monday, etc.
+  repeated bool weekdays = 3
+      [ (nanopb).max_count = 7, (nanopb).fixed_length = true ];
 
   repeated BlueLocalTimeperiod timePeriods = 8 [ (nanopb).max_count = 4 ];
 }

package/BlueSystem.proto

@@ -9,22 +9,17 @@ 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 ];
+  required string isoCountry = 1 [ (nanopb).max_length = 2 ];
+  required string isoState = 2 [ (nanopb).max_length = 3 ];
+
+  required int32 utcOffsetMinutes = 3
+      [ (nanopb).int_size = IS_16, default = 0 ];
 
   // 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 ];
+  required bool autoCheckSystemStatus = 4 [ default = false ];
 }
 
 message BlueBleConfig {
@@ -39,64 +34,59 @@ message BlueBleConfig {
   // 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 ];
+      [ (nanopb).int_size = IS_8, (nanopb).max_count = 4 ];
 
   // The desired advertising interval in ms
-  required uint32 advertisingIntervalMs = 4 [ default = 500 ];
+  required uint32 advertisingIntervalMs = 4
+      [ (nanopb).int_size = IS_16, default = 500 ];
 
   // The maximal connection timeout per connection in milliseconds
-  required uint32 maxConnectionTimeoutMs = 5 [ default = 3000 ];
+  required uint32 maxConnectionTimeoutMs = 5
+      [ (nanopb).int_size = IS_16, default = 3000 ];
 
   // The actual tx power level used for bluetooth from (0 - lowest) to 7
   // (highest)
-  required uint32 txPowerLevel = 6 [ default = 3 ];
+  required uint32 txPowerLevel = 6 [ (nanopb).int_size = IS_8, default = 3 ];
 
   // The advertised tx power level at 1 meter in decibel (-XX - +XX)
-  required int32 advertisedTxPower1Meter = 7 [ default = -77 ];
+  required int32 advertisedTxPower1Meter = 7
+      [ (nanopb).int_size = IS_8, 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
+  // Schedules when it should go online for updating. Only applies to
+  // battery-powered devices with wifi or gsm module. If no schedule is set will
+  // never go online. The end time is not used.
+  repeated BlueLocalTimeSchedule connectSchedules = 1
       [ (nanopb).max_count = 4 ];
 
   // The SSID of the wifi network
-  required string wifiSSID = 3 [ (nanopb).max_length = 32 ];
+  required string wifiSSID = 2 [ (nanopb).max_length = 32 ];
 
   // The wifi password
-  required string wifiPassword = 4 [ (nanopb).max_length = 32 ];
+  required string wifiPassword = 3 [ (nanopb).max_length = 32 ];
 
   // Default timeout for online connections
-  required uint32 timeoutSec = 5 [ default = 30 ];
+  required uint32 timeoutSec = 4 [ (nanopb).int_size = IS_16, default = 30 ];
+}
+
+message BlueAccessConfigGroup {
+  required uint32 groupId = 1 [ (nanopb).int_size = IS_8 ];
+  repeated BlueLocalTimeSchedule schedules = 2 [ (nanopb).max_count = 2 ];
 }
 
 message BlueAccessConfig {
   // The device's unique access id
-  required uint32 id = 1 [ default = 1 ];
+  required uint32 id = 1 [ (nanopb).int_size = IS_8, default = 1 ];
 
   // The site id bound to this device
-  required uint32 siteId = 2 [ default = 1 ];
+  required uint32 siteId = 2 [ (nanopb).int_size = IS_8, default = 1 ];
 
   // The access groups this device is part of
-  repeated uint32 groupIds = 3 [ (nanopb).max_count = 16 ];
+  repeated BlueAccessConfigGroup groups = 3 [ (nanopb).max_count = 10 ];
 }
 
 message BlueOssConfig {
@@ -149,7 +139,7 @@ message BlueOssConfig {
 }
 
 message BlueSystemConfig {
-  required uint32 version = 1;
+  required string configId = 1 [ (nanopb).max_length = 8 ];
   // -- Base
   required BlueBaseConfig base = 2;
   required BlueBleConfig ble = 3;
@@ -168,18 +158,25 @@ message BlueSystemUpdate {
 }
 
 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 blacklistMaxEntriesCount = 1
+      [ (nanopb).int_size = IS_16, default = 0 ];
+  required uint32 blacklistEntriesCount = 2
+      [ (nanopb).int_size = IS_16, default = 0 ];
+
+  required uint32 eventLogMaxEntriesCount = 3
+      [ (nanopb).int_size = IS_16, default = 0 ];
+  required uint32 eventLogEntriesCount = 4
+      [ (nanopb).int_size = IS_16, default = 0 ];
   required uint32 eventLogSequenceId = 5 [ default = 0 ];
-  required uint32 eventLogIndex = 6 [ default = 0 ];
+  required uint32 eventLogIndex = 6 [ (nanopb).int_size = IS_16, default = 0 ];
 
-  required uint32 systemLogMaxEntriesCount = 7 [ default = 0 ];
-  required uint32 systemLogEntriesCount = 8 [ default = 0 ];
+  required uint32 systemLogMaxEntriesCount = 7
+      [ (nanopb).int_size = IS_16, default = 0 ];
+  required uint32 systemLogEntriesCount = 8
+      [ (nanopb).int_size = IS_16, default = 0 ];
   required uint32 systemLogSequenceId = 9 [ default = 0 ];
-  required uint32 systemLogIndex = 10 [ default = 0 ];
+  required uint32 systemLogIndex = 10
+      [ (nanopb).int_size = IS_16, default = 0 ];
 
   required bool timeWasSet = 11;
 
@@ -203,7 +200,7 @@ message BlueSystemProvisioning {
 }
 
 message BlueSystemStatus {
-  required uint32 configVersion = 1;
+  required string configId = 1 [ (nanopb).max_length = 8 ];
   required string deviceId = 2 [ (nanopb).max_length = 8 ];
   required string serialNumber = 3 [ (nanopb).max_length = 20 ];
   required BlueHardwareType hardwareType = 4;
@@ -211,10 +208,10 @@ message BlueSystemStatus {
   required uint32 applicationVersion = 6;
   required BlueLocalTimestamp localTime = 7;
   required BlueSystemSettings settings = 8;
-  required uint32 blacklistEntriesCount = 9;
-  required uint32 eventLogEntriesCount = 10;
+  required uint32 blacklistEntriesCount = 9 [ (nanopb).int_size = IS_16 ];
+  required uint32 eventLogEntriesCount = 10 [ (nanopb).int_size = IS_16 ];
   required uint32 eventLogSequenceId = 11;
-  required uint32 systemLogEntriesCount = 12;
+  required uint32 systemLogEntriesCount = 12 [ (nanopb).int_size = IS_16 ];
   required uint32 systemLogSequenceId = 13;
 
   // -- Custom
@@ -226,7 +223,7 @@ message BlueSystemStatus {
 ///////////////////////////////////////////////////////////////////////
 
 message BlueSystemLogQuery {
-  required uint32 maxCount = 1;
+  required uint32 maxCount = 1 [ (nanopb).int_size = IS_8 ];
 
   oneof start {
     uint32 sequenceId = 2;
@@ -239,9 +236,10 @@ message BlueSystemLogEntry {
 
   required BlueLocalTimestamp time = 2;
 
-  required uint32 severity = 3;
+  required uint32 severity = 3 [ (nanopb).int_size = IS_8 ];
 
-  required uint32 line = 4;
+  required uint32 line = 4 [ (nanopb).int_size = IS_16 ];
+  ;
 
   required string file = 5 [ (nanopb).max_length = 20 ];