Skip to content

Releases: braiins/bos-plus-api

1.10.0

15 Apr 12:56

Choose a tag to compare

[1.10.0] - 2026-04-15

Added

  • Introduced new field best_share_str in braiins.bos.v1.WorkSolverStats and braiins.bos.v1.PoolStats messages to provide best share value as a decimal string, supporting values larger than 2^64-1.
  • Introduced new method SystemUpgrade in the braiins.bos.v1.UpgradeService. User can now send firmware and do system upgrade.
  • Introduced new method RestoreStock in the braiins.bos.v1.UpgradeService. User can restore stock firmware.
  • Introduced new braiins.bos.v1.LogType enumeration 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_share in braiins.bos.v1.WorkSolverStats and braiins.bos.v1.PoolStats messages. Use best_share_str instead to avoid overflow for values exceeding 2^64-1.

1.9.0

18 Feb 13:46

Choose a tag to compare

[1.9.0] - 2026-02-18

Added

  • Added on_start_target_percent field in the braiins.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.FanPauseRuntime with FAN_PAUSE_RUNTIME_LIMITED and FAN_PAUSE_RUNTIME_INDEFINITE variants.
  • Introduced new field fan_pause_runtime in the braiins.bos.v1.ManualPauseMode message to configure fan runtime duration in manual pause mode.
  • Introduced new field default_fan_pause_runtime in the braiins.bos.v1.CoolingConstraints message to get default fan pause runtime.
  • Introduced new field fan_pause_runtime_limited_duration_s in the braiins.bos.v1.CoolingConstraints message to get fan pause runtime limited duration.

Changed

  • Extended braiins.bos.v1.TunerState enumeration with TUNER_STATE_CONTINUOUS variant,

1.8.0

25 Nov 16:28

Choose a tag to compare

[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 uid in the braiins.bos.v1.PoolGroup message to get group uid.
  • Introduced new service braiins.bos.v1.UpgradeService with methods:
    • UpdateAutoUpgradeConfig - enables/disables AutoUpgrade feature and configures upgrade schedule
    • GetAutoUpgradeStatus - retrieves current AutoUpgrade configuration and execution status
  • Introduced new messages for AutoUpgrade scheduling:
    • units.DayOfWeek enum and custom upgrade.UpgradeTime message for schedule configuration
    • DailySchedule - schedule upgrades to run daily at a specific time
    • WeeklySchedule - schedule upgrades to run weekly on a specific day of the week at a specific time
    • MonthlySchedule - schedule upgrades to run monthly on a specific day of the month (1-28) at a specific time
    • AutoUpgradeSchedule - oneof message that can contain any of the schedule types
    • UpdateAutoUpgradeConfigRequest - request message to update AutoUpgrade configuration
    • UpdateAutoUpgradeConfigResponse - response message containing enabled status and next execution timestamp
    • GetAutoUpgradeStatusRequest - request message to get AutoUpgrade status
    • GetAutoUpgradeStatusResponse - response message containing enabled status, schedule, next execution, and last execution timestamps
  • Introduced new enumeration RelativeTargetReference with NOMINAL, MIN, MAX and CURRENT variants.
  • Introduced new message SetRelativeTargetRequest with save_action, percentage and reference fields.
  • Introduced new methods SetRelativePowerTarget and SetRelativeHashrateTarget. User can now set power and hashrate targets relative to a reference value

1.7.0

10 Aug 16:10

Choose a tag to compare

[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.FanPauseMode with FAN_PAUSE_MODE_AUTO and FAN_PAUSE_MODE_MANUAL variants.
  • Introduced new field default_fan_pause_mode in the braiins.bos.v1.CoolingConstraints message to get default fan pause mode.
  • Introduced new messages braiins.bos.v1.SetQuickRampingRequest, braiins.bos.v1.QuickRampingResponse and braiins.bos.v1.SetDefaultQuickRampingRequest.
  • Introduced new method SetQuickRamping in the braiins.bos.v1.PerformanceService. User can now set quick ramping time up and down values.
  • Introduced new method SetDefaultQuickRamping in the braiins.bos.v1.PerformanceService. User can now set quick ramping time up and down to default.
  • Introduced new fields quick_ramping_time_up_s and quick_ramping_time_down_s in the braiins.bos.v1.HashboardPerformanceConfiguration message to get quick ramping time up and down values.
  • Introduced new field quick_ramping_time_s in the braiins.bos.v1.HashboardConstraints message to get quick ramping time constraints.

Changed

  • Mark uid for braiins.bos.v1.PoolGroupConfiguration and braiins.bos.v1.PoolConfiguration as optional. This change allows to create new pool group or pool without providing empty uid value. When new entity is created uid is generated automatically. When updating existing Pool Group with UpdatePoolGroup method, uid is required, otherwise error is returned back to the user.

1.6.0

10 Jun 16:16

Choose a tag to compare

[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, AutoPauseMode and ManualPauseMode.
  • Introduced new field pause_mode in the braiins.bos.v1.CoolingAutoMode message to set and get pause cooldown fan speed for automatic cooling mode.
  • Introduced new field pause_mode in the braiins.bos.v1.CoolingManualMode message to set and get pause cooldown fan speed for manual cooling mode.
  • Introduced new field pause_cooldown_fan_speed_ratio in the braiins.bos.v1.CoolingConstraints message to get pause cooldown fan speed constraints.
  • Introduced new method ApplyContractKey in the braiins.bos.v1.LicenseService. User can now apply contract key to miner and get licence.

1.5.0

09 Apr 12:34

Choose a tag to compare

[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_temp in the braiins.bos.v1.Hashboard message to get the lowest inlet and highest outlet temperature for a specific hashboard.
  • Introduced new fields serial_number, board_name and chip_type in the braiins.bos.v1.Hashboard message.
  • Introduced new PsuInfo message and added it to the braiins.bos.v1.GetMinerDetailsResponse message.
  • Introduced new ControlBoardSocFamily enumeration and added it to the braiins.bos.v1.GetMinerDetailsResponse message.
  • Introduced new field serial_number in the braiins.bos.v1.GetMinerDetailsResponse message.

1.4.0

27 Feb 09:23

Choose a tag to compare

[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.DPSMode with DPS_MODE_NORMAL and DPS_MODE_BOOST variants.
  • Introduced new field mode in the braiins.bos.v1.DPSConfiguration, braiins.bos.v1.SetDPSRequest, braiins.bos.v1.SetDPSResponse message to get or set DPS mode.
  • Introduced new field mode in the braiins.bos.v1.DPSConstraints message to get the default value for DPS mode.
  • Introduced new method SetCoolingMode in the braiins.bos.v1.CoolingService. User can now set cooling mode to automatic, manual, hydro or immersion. It gives user possibility to set specific temperature and fan settings for each mode.
  • Introduced new field min_fan_speed in the braiins.bos.v1.CoolingAutoMode to set minimum fan speed for automatic cooling mode.
  • Introduced new field max_fan_speed in the braiins.bos.v1.CoolingAutoMode to set maximum fan speed for automatic cooling mode.
  • Introduced new field min_fan_speed in the braiins.bos.v1.CoolingConstraints to get default value for minimum fan speed for automatic cooling mode.
  • Introduced new field max_fan_speed in the braiins.bos.v1.CoolingConstraints to get default value for maximum fan speed for automatic cooling mode.
  • Introduced new field target_temperature in the braiins.bos.v1.CoolingManualMode to set target temperature for manual cooling mode.

Changed

  • Mark SetImmersionMode method as deprecated in CoolingService. Instead of this method, user should use SetCoolingMode with immersion mode.
  • Extend CoolingConfiguration mode with new value immersion that represents immersion cooling mode.
  • Extend CoolingConfiguration mode with new value hydro that represents hydro cooling mode.
  • Mark disabled cooling mode as deprecated in CoolingConfiguration mode.
  • Mark minimum_required_fans field as deprecated in CoolingConfiguration. Instead user should use minimum_required_fans field in CoolingAutoMode or CoolingManualMode.
  • Extend CoolingAutoMode with new field minimum_required_fans.
  • Extend CoolingManualMode with new field minimum_required_fans.

1.3.0

22 Oct 10:26

Choose a tag to compare

[1.3.0] - 2024-10-22

Version 1.3.0 introduces few small improvements.

Changed

  • Extended braiins.bos.v1.Platform enumeration with PLATFORM_STM32MP157C_II2_BMM1 variant,
  • Extended braiins.bos.v1.SupportArchiveFormat enumeration with SUPPORT_ARCHIVE_FORMAT_ZIP_ENCRYPTED variant.

1.2.0

17 Jul 09:59

Choose a tag to compare

[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 model in the braiins.bos.v1.Hashboard message that contains hashboard name,
  • Introduced new method GetErrors in the braiins.bos.v1.MinerService to get all miner errors,
  • Introduced new method SetPoolGroups in the braiins.bos.v1.PoolService to set all Pool groups at once.

1.1.0

09 May 10:54

Choose a tag to compare

[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_time in the braiins.bos.v1.PoolStats that provides info about last share time,
  • Introduced new field token in the braiins.bos.v1.LoginResponse that provides info created authentication token that was till now available only in response header,
  • Introduced new field timeout_s in the braiins.bos.v1.LoginResponse that provides info about authentication token expiration time,
  • Introduced new method GetNetworkInfo in the braiins.bos.v1.NetworkService to get current network configuration for the default network interface,
  • Introduced new field kernel_version in the braiins.bos.v1.GetMinerDetailsResponse that provides info about Kernel version.