Releases: braiins/bos-plus-api
1.10.0
[1.10.0] - 2026-04-15
Added
- Introduced new field
best_share_strinbraiins.bos.v1.WorkSolverStatsandbraiins.bos.v1.PoolStatsmessages to provide best share value as a decimal string, supporting values larger than 2^64-1. - Introduced new method
SystemUpgradein thebraiins.bos.v1.UpgradeService. User can now send firmware and do system upgrade. - Introduced new method
RestoreStockin thebraiins.bos.v1.UpgradeService. User can restore stock firmware. - Introduced new
braiins.bos.v1.LogTypeenumeration with log type variants for downloading miner logs. - Introduced new streaming method
braiins.bos.v1.MinerService::GetLog()to download merged miner log files.
Changed
- Deprecated field
best_shareinbraiins.bos.v1.WorkSolverStatsandbraiins.bos.v1.PoolStatsmessages. Usebest_share_strinstead to avoid overflow for values exceeding 2^64-1.
1.9.0
[1.9.0] - 2026-02-18
Added
- Added
on_start_target_percentfield in thebraiins.bos.v1.DPSConfiguration,braiins.bos.v1.DPSConstraints,braiins.bos.v1.SetDPSRequest,braiins.bos.v1.SetDPSResponse. This change allows to specify the target that the Dynamic Performance Scaling starts from. - Introduced new
braiins.bos.v1.ActionsService::FactoryReset()method to perform factory reset. - Introduced new enumeration
braiins.bos.v1.FanPauseRuntimewithFAN_PAUSE_RUNTIME_LIMITEDandFAN_PAUSE_RUNTIME_INDEFINITEvariants. - Introduced new field
fan_pause_runtimein thebraiins.bos.v1.ManualPauseModemessage to configure fan runtime duration in manual pause mode. - Introduced new field
default_fan_pause_runtimein thebraiins.bos.v1.CoolingConstraintsmessage to get default fan pause runtime. - Introduced new field
fan_pause_runtime_limited_duration_sin thebraiins.bos.v1.CoolingConstraintsmessage to get fan pause runtime limited duration.
Changed
- Extended
braiins.bos.v1.TunerStateenumeration withTUNER_STATE_CONTINUOUSvariant,
1.8.0
[1.8.0] - 2025-11-25
Version 1.8.0 introduces new Upgrade service braiins.bos.v1.UpgradeService and relative power/hashrate target configuration.
Added
- Introduced new field
uidin thebraiins.bos.v1.PoolGroupmessage to get group uid. - Introduced new service
braiins.bos.v1.UpgradeServicewith methods:UpdateAutoUpgradeConfig- enables/disables AutoUpgrade feature and configures upgrade scheduleGetAutoUpgradeStatus- retrieves current AutoUpgrade configuration and execution status
- Introduced new messages for AutoUpgrade scheduling:
units.DayOfWeekenum and customupgrade.UpgradeTimemessage for schedule configurationDailySchedule- schedule upgrades to run daily at a specific timeWeeklySchedule- schedule upgrades to run weekly on a specific day of the week at a specific timeMonthlySchedule- schedule upgrades to run monthly on a specific day of the month (1-28) at a specific timeAutoUpgradeSchedule- oneof message that can contain any of the schedule typesUpdateAutoUpgradeConfigRequest- request message to update AutoUpgrade configurationUpdateAutoUpgradeConfigResponse- response message containing enabled status and next execution timestampGetAutoUpgradeStatusRequest- request message to get AutoUpgrade statusGetAutoUpgradeStatusResponse- response message containing enabled status, schedule, next execution, and last execution timestamps
- Introduced new enumeration
RelativeTargetReferencewithNOMINAL,MIN,MAXandCURRENTvariants. - Introduced new message
SetRelativeTargetRequestwithsave_action,percentageandreferencefields. - Introduced new methods
SetRelativePowerTargetandSetRelativeHashrateTarget. User can now set power and hashrate targets relative to a reference value
1.7.0
[1.7.0] - 2025-08-10
Version 1.7.0 introduces changes to braiins.bos.v1.PoolGroupConfiguration and braiins.bos.v1.PoolConfiguration.
Added
- Introduced new enumeration
braiins.bos.v1.FanPauseModewithFAN_PAUSE_MODE_AUTOandFAN_PAUSE_MODE_MANUALvariants. - Introduced new field
default_fan_pause_modein thebraiins.bos.v1.CoolingConstraintsmessage to get default fan pause mode. - Introduced new messages
braiins.bos.v1.SetQuickRampingRequest,braiins.bos.v1.QuickRampingResponseandbraiins.bos.v1.SetDefaultQuickRampingRequest. - Introduced new method
SetQuickRampingin thebraiins.bos.v1.PerformanceService. User can now set quick ramping time up and down values. - Introduced new method
SetDefaultQuickRampingin thebraiins.bos.v1.PerformanceService. User can now set quick ramping time up and down to default. - Introduced new fields
quick_ramping_time_up_sandquick_ramping_time_down_sin thebraiins.bos.v1.HashboardPerformanceConfigurationmessage to get quick ramping time up and down values. - Introduced new field
quick_ramping_time_sin thebraiins.bos.v1.HashboardConstraintsmessage to get quick ramping time constraints.
Changed
- Mark
uidforbraiins.bos.v1.PoolGroupConfigurationandbraiins.bos.v1.PoolConfigurationas optional. This change allows to create new pool group or pool without providing emptyuidvalue. When new entity is createduidis generated automatically. When updating existing Pool Group withUpdatePoolGroupmethod,uidis required, otherwise error is returned back to the user.
1.6.0
[1.6.0] - 2025-06-10
Version 1.6.0 introduces enhanced control of fan behavior during cooling mode curtailment and adds ability to apply Custom Contracts.
Added
- Introduced new messages
PauseMode,AutoPauseModeandManualPauseMode. - Introduced new field
pause_modein thebraiins.bos.v1.CoolingAutoModemessage to set and get pause cooldown fan speed for automatic cooling mode. - Introduced new field
pause_modein thebraiins.bos.v1.CoolingManualModemessage to set and get pause cooldown fan speed for manual cooling mode. - Introduced new field
pause_cooldown_fan_speed_ratioin thebraiins.bos.v1.CoolingConstraintsmessage to get pause cooldown fan speed constraints. - Introduced new method
ApplyContractKeyin thebraiins.bos.v1.LicenseService. User can now apply contract key to miner and get licence.
1.5.0
[1.5.0] - 2025-04-09
Version 1.5.0 extends Hashboard message to provide lowest inlet and highest outlet temperatures. And HW info including miner serial number from stock FW.
Added
- Introduced new fields
lowest_inlet_temp,highest_outlet_tempin thebraiins.bos.v1.Hashboardmessage to get the lowest inlet and highest outlet temperature for a specific hashboard. - Introduced new fields
serial_number,board_nameandchip_typein thebraiins.bos.v1.Hashboardmessage. - Introduced new
PsuInfomessage and added it to thebraiins.bos.v1.GetMinerDetailsResponsemessage. - Introduced new
ControlBoardSocFamilyenumeration and added it to thebraiins.bos.v1.GetMinerDetailsResponsemessage. - Introduced new field
serial_numberin thebraiins.bos.v1.GetMinerDetailsResponsemessage.
1.4.0
[1.4.0] - 2025-02-26
Version 1.4.0 introduces possibility to set DPS mode to normal or boost. It also extends cooling configuration with new values immersion and hydro.
Added
- Introduced new enumeration
braiins.bos.v1.DPSModewithDPS_MODE_NORMALandDPS_MODE_BOOSTvariants. - Introduced new field
modein thebraiins.bos.v1.DPSConfiguration,braiins.bos.v1.SetDPSRequest,braiins.bos.v1.SetDPSResponsemessage to get or set DPS mode. - Introduced new field
modein thebraiins.bos.v1.DPSConstraintsmessage to get the default value for DPS mode. - Introduced new method
SetCoolingModein thebraiins.bos.v1.CoolingService. User can now set cooling mode toautomatic,manual,hydroorimmersion. It gives user possibility to set specific temperature and fan settings for each mode. - Introduced new field
min_fan_speedin thebraiins.bos.v1.CoolingAutoModeto set minimum fan speed for automatic cooling mode. - Introduced new field
max_fan_speedin thebraiins.bos.v1.CoolingAutoModeto set maximum fan speed for automatic cooling mode. - Introduced new field
min_fan_speedin thebraiins.bos.v1.CoolingConstraintsto get default value for minimum fan speed for automatic cooling mode. - Introduced new field
max_fan_speedin thebraiins.bos.v1.CoolingConstraintsto get default value for maximum fan speed for automatic cooling mode. - Introduced new field
target_temperaturein thebraiins.bos.v1.CoolingManualModeto set target temperature for manual cooling mode.
Changed
- Mark
SetImmersionModemethod as deprecated inCoolingService. Instead of this method, user should useSetCoolingModewithimmersionmode. - Extend
CoolingConfigurationmode with new valueimmersionthat represents immersion cooling mode. - Extend
CoolingConfigurationmode with new valuehydrothat represents hydro cooling mode. - Mark
disabledcooling mode as deprecated inCoolingConfigurationmode. - Mark
minimum_required_fansfield as deprecated inCoolingConfiguration. Instead user should useminimum_required_fansfield inCoolingAutoModeorCoolingManualMode. - Extend
CoolingAutoModewith new fieldminimum_required_fans. - Extend
CoolingManualModewith new fieldminimum_required_fans.
1.3.0
[1.3.0] - 2024-10-22
Version 1.3.0 introduces few small improvements.
Changed
- Extended
braiins.bos.v1.Platformenumeration withPLATFORM_STM32MP157C_II2_BMM1variant, - Extended
braiins.bos.v1.SupportArchiveFormatenumeration withSUPPORT_ARCHIVE_FORMAT_ZIP_ENCRYPTEDvariant.
1.2.0
[1.2.0] - 2024-07-17
Version 1.2.0 introduces the possibility to configure all pool groups at once and read Braiins OS errors.
Added
- Introduced new field
modelin thebraiins.bos.v1.Hashboardmessage that contains hashboard name, - Introduced new method
GetErrorsin thebraiins.bos.v1.MinerServiceto get all miner errors, - Introduced new method
SetPoolGroupsin thebraiins.bos.v1.PoolServiceto set all Pool groups at once.
1.1.0
[1.1.0] - 2024-05-09
Version 1.1.0 introduce possibility to read network configuration, changes in authentication and few more changes.
Added
- Introduced new field
last_share_timein thebraiins.bos.v1.PoolStatsthat provides info about last share time, - Introduced new field
tokenin thebraiins.bos.v1.LoginResponsethat provides info created authentication token that was till now available only in response header, - Introduced new field
timeout_sin thebraiins.bos.v1.LoginResponsethat provides info about authentication token expiration time, - Introduced new method
GetNetworkInfoin thebraiins.bos.v1.NetworkServiceto get current network configuration for the default network interface, - Introduced new field
kernel_versionin thebraiins.bos.v1.GetMinerDetailsResponsethat provides info about Kernel version.