You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+30-3Lines changed: 30 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,6 +7,7 @@ This repository contains protocol buffers for the new Braiins OS Public API, whi
7
7
8
8
| Public API Version | Braiins OS version |
9
9
|--------------------|--------------------|
10
+
| 1.8.0 | 25.11 |
10
11
| 1.7.0 | 25.07 |
11
12
| 1.6.0 | 25.05 |
12
13
| 1.5.0 | 25.03 |
@@ -91,6 +92,7 @@ braiins.bos.v1.CoolingService
91
92
braiins.bos.v1.MinerService
92
93
braiins.bos.v1.PoolService
93
94
braiins.bos.v1.TunerService
95
+
braiins.bos.v1.UpgradeService
94
96
grpc.reflection.v1alpha.ServerReflection
95
97
```
96
98
@@ -268,10 +270,35 @@ Contains pools related messages and **PoolService** with various methods to read
268
270
#### 12. proto/bos/v1/units.proto
269
271
Contains protobuf messages representing various units like Voltage, Frequency, etc.
270
272
271
-
#### 13. proto/bos/v1/work.proto
273
+
#### 13. proto/bos/v1/upgrade.proto
274
+
Contains upgrade related messages and **UpgradeService** with methods to configure and monitor automatic firmware upgrades:
275
+
***UpdateAutoUpgradeConfig** - method to enable/disable AutoUpgrade feature and configure upgrade schedule,
276
+
***GetAutoUpgradeStatus** - method to retrieve current AutoUpgrade configuration and execution status.
277
+
278
+
The AutoUpgrade feature allows the miner to automatically upgrade its firmware according to a configured schedule. You can schedule upgrades to run:
279
+
***Daily** - at a specific time each day
280
+
***Weekly** - on a specific day of the week at a specific time
281
+
***Monthly** - on a specific day of the month (1-28) at a specific time
282
+
283
+
**Notes:**
284
+
* The `dayOfWeek` field uses the `units.DayOfWeek` enum with value for each day in a week.
285
+
* The `time` field uses the `UpgradeTime` message with fields:
286
+
*`hours` - hour of day in 24-hour format (0-23)
287
+
*`minutes` - minutes of hour (0-59)
288
+
*`seconds` - seconds of minute (0-59, optional, defaults to 0)
289
+
* For monthly schedules, `dayOfMonth` is limited to values 1-28 to ensure compatibility across all months
290
+
* When updating the configuration, both `enabled` and `schedule` fields are optional - you can update just one or both
291
+
* The `lastExecution` timestamp indicates when the last automatic upgrade was performed (if any)
292
+
* The `nextExecution` timestamp indicates when the next automatic upgrade will occur
293
+
***Important**: When schedule attributes are not supplied, they will be randomized:
294
+
* For `DailySchedule`: if `time` (hours/minutes) is not set, a random time of day will be generated
295
+
* For `WeeklySchedule`: if `dayOfWeek` is not set, a random day of the week will be generated; if `time` is not set, a random time of day will be generated
296
+
* For `MonthlySchedule`: if `dayOfMonth` is not set, a random day (1-28) will be generated; if `time` is not set, a random time of day will be generated
297
+
298
+
#### 14. proto/bos/v1/work.proto
272
299
Contains mining work related protobuf messages.
273
300
274
-
#### 14. proto/bos/version.proto
301
+
#### 15. proto/bos/version.proto
275
302
Contains **ApiVersionService** service with **GetApiVersion** to be able to read current Public API version available for communication with miner
276
303
277
304
@@ -280,4 +307,4 @@ Contains **ApiVersionService** service with **GetApiVersion** to be able to read
280
307
### Contact
281
308
Do you have questions or specific needs from the API? Our dev and support teams are always available to help. You can send a request to our support team or open a GitHub issue.
282
309
283
-
You can also join our Telegram group at https://t.me/BraiinsOS point and customize it to fit your project's specific needs.
310
+
You can also join our Telegram group at https://t.me/BraiinsOS point and customize it to fit your project's specific needs.
0 commit comments