1.0.0-beta.4 release

- updated proto files
- updated README.md
- updated CHANGELOG.md

CHANGELOG.md

@@ -1,5 +1,16 @@
 # Changelog
 
+## [1.0.0-beta.4] - 2023-11-23
+Version **1.0.0-beta.4** contains one new feature and one breaking change.
+
+### Added
+* We added option to clean tuner profiles by adding `braiins.bos.v1.PerformanceService::RemoveTunedProfiles`
+* Introduced a new field `system_uptime_s` in the `braiins.bos.v1.GetMinerDetailsResponse` that replaces `system_uptime`(marked as deprecated) to keep the best practice that a field name should also describe the unit (when applicable).
+
+### Breaking Changes:
+* We reverted removing `braiins.bos.v1.MinerModel` enumeration from the previous release because this change was causing troubles to our users.
+  Instead of dropping enumeration, we decided to mark it as deprecated and introduce new field `miner_model` for string representation.
+
 ## [1.0.0-beta.3] - 2023-11-02
 Version **1.0.0-beta.3** contains a few minor improvements.
 

README.md

@@ -7,7 +7,8 @@ This repository contains protocol buffers for the new Braiins OS+ Public API, wh
 
 | Public API Version    | BOS+ version |
 |-----------------------|--------------|
-| 1.0.0-beta.3 (latest) | 23.10        |
+| 1.0.0-beta.4 (latest) | 23.10.1      |
+| 1.0.0-beta.3          | 23.10        |
 | 1.0.0-beta.2          | 23.08        |
 | 1.0.0-beta.1          | 23.05        |
 | 1.0.0-beta            | 23.04        |

proto/bos/v1/miner.proto

@@ -58,10 +58,39 @@ enum MinerBrand {
   MINER_BRAND_WHATSMINER = 2;
 }
 
+// Deprecated: This enumeration is not longer maintained
+enum MinerModel {
+  option deprecated = true;
+  MINER_MODEL_UNSPECIFIED = 0;
+  MINER_MODEL_ANTMINER_S9 = 1;
+  MINER_MODEL_ANTMINER_X17 = 2;
+  MINER_MODEL_ANTMINER_S17 = 3;
+  MINER_MODEL_ANTMINER_S17_PLUS = 4;
+  MINER_MODEL_ANTMINER_S17_PRO = 5;
+  MINER_MODEL_ANTMINER_S17E = 6;
+  MINER_MODEL_ANTMINER_T17 = 7;
+  MINER_MODEL_ANTMINER_T17E = 8;
+  MINER_MODEL_ANTMINER_T17_PLUS = 9;
+  MINER_MODEL_ANTMINER_X19 = 10;
+  MINER_MODEL_ANTMINER_S19 = 11;
+  MINER_MODEL_ANTMINER_S19_PRO = 12;
+  MINER_MODEL_ANTMINER_S19_PLUS = 13;
+  MINER_MODEL_ANTMINER_S19J = 14;
+  MINER_MODEL_ANTMINER_S19J_PRO = 15;
+  MINER_MODEL_ANTMINER_S19A = 16;
+  MINER_MODEL_ANTMINER_S19A_PRO = 17;
+  MINER_MODEL_ANTMINER_S19XP = 18;
+  MINER_MODEL_ANTMINER_T19 = 19;
+  MINER_MODEL_ANTMINER_S19J_PRO_PLUS = 20;
+}
+
 message MinerIdentity {
   MinerBrand brand = 1;
-  string model = 2;
+  // Deprecated: Use miner_model instead.
+  // This field is no longer supported.
+  MinerModel model = 2 [deprecated = true];
   string name = 3;
+  string miner_model = 4;
 }
 
 // Structure to handle BOS version
@@ -104,12 +133,14 @@ message GetMinerDetailsResponse {
   string hostname = 6;
   // MAC address
   string mac_address = 7;
-  // System uptime
-  uint64 system_uptime = 8;
+  // Deprecated: Use system_uptime_s
+  uint64 system_uptime = 8 [deprecated = true];
   // Miner hashrate declared by manufacturer
   braiins.bos.v1.GigaHashrate sticker_hashrate = 9;
   // Bosminer uptime. `0` means bosminer is not running
   uint64 bosminer_uptime_s = 10;
+  // System uptime
+  uint64 system_uptime_s = 11;
 }
 
 message MinerPowerStats {

proto/bos/v1/performance.proto

@@ -354,6 +354,10 @@ message PerformanceMode {
 
 message GetPerformanceModeRequest {}
 
+message RemoveTunedProfilesRequest {}
+
+message RemoveTunedProfilesResponse {}
+
 service PerformanceService {
   // Method to get the current tuner details
   rpc GetTunerState(GetTunerStateRequest) returns (GetTunerStateResponse);
@@ -381,4 +385,6 @@ service PerformanceService {
   rpc SetPerformanceMode(SetPerformanceModeRequest) returns (PerformanceMode);
   // Method to read active(runtime) performance mode
   rpc GetActivePerformanceMode(GetPerformanceModeRequest) returns (PerformanceMode);
+  // Method to remove tuned profiles
+  rpc RemoveTunedProfiles(RemoveTunedProfilesRequest) returns (RemoveTunedProfilesResponse);
 }

proto/bos/version.proto

@@ -31,7 +31,7 @@ package braiins.bos;
 // proto3 extensions and proto3 does not allow specifying custom
 // default values. Value follows semver format.
 
-// LATEST_API_VERSION=1.0.0-beta.3
+// LATEST_API_VERSION=1.0.0-beta.4
 message ApiVersion {
   uint64 major = 1;
   uint64 minor = 2;