Project braiins/bos-plus-api

BOS_MODE_UNSPECIFIED = 0
BOS_MODE_UPGRADE = 1
BOS_MODE_RECOVERY = 2
BOS_MODE_SD = 3
BOS_MODE_NAND = 4
BOS_MODE_EMMC = 5

Structure to handle BOS version

string current = 1
string major = 2
bool bos_plus = 3

Used in: MinerError

string name = 1
uint32 index = 2

Control board soc family “CVITEK”, “BBB”, “AML”, “ZYNQ”, "BRAIINS"

CONTROL_BOARD_SOC_FAMILY_UNSPECIFIED = 0
CONTROL_BOARD_SOC_FAMILY_CVITEK = 1
CONTROL_BOARD_SOC_FAMILY_BBB = 2
CONTROL_BOARD_SOC_FAMILY_AML = 3
CONTROL_BOARD_SOC_FAMILY_ZYNQ = 4
CONTROL_BOARD_SOC_FAMILY_BRAIINS = 5

The temperature control modes. Miner software tries to regulate the fan speed so that miner temperature is approximately at the target temperature. The allowed temperature range is 0-200 degree Celsius.

Used in: CoolingConfiguration, SetCoolingModeRequest, SetCoolingModeResponse

optional Temperature target_temperature = 1
Temperature that the miner will try to maintain
optional Temperature hot_temperature = 2
Temperature threshold at which the fans start to run at 100%.
optional Temperature dangerous_temperature = 3
Temperature threshold at which BOSMiner shuts down in order to prevent overheating and damaging the miner.
optional uint32 min_fan_speed = 4
Minimum fan speed expressed as a value between 0 and 100. min_fan_speed must be less than max_fan_speed.
optional uint32 max_fan_speed = 5
Maximum fan speed expressed as a value between 0 and 100. max_fan_speed must be greater than min_fan_speed.
optional uint32 minimum_required_fans = 6
Minimum number of fans required to have BOSminer operational.
optional PauseMode pause_mode = 7
Pause mode used for fans when the miner is paused

optional uint32 minimum_required_fans = 1
Minimum number of fans required to have BOSminer operational.
oneof mode
- CoolingAutoMode auto = 2
- CoolingManualMode manual = 3
- CoolingDisabledMode disabled = 4
- CoolingImmersionMode immersion = 5
- CoolingHydroMode hydro = 6

CoolingMode default_cooling_mode = 1
optional TemperatureConstraints target_temperature = 2
optional TemperatureConstraints hot_temperature = 3
optional TemperatureConstraints dangerous_temperature = 4
optional DoubleConstraints fan_speed_ratio = 5
optional UInt32Constraints minimum_required_fans = 6
optional UInt32Constraints min_fan_speed = 7
optional UInt32Constraints max_fan_speed = 8
optional DoubleConstraints pause_cooldown_fan_speed_ratio = 9
optional FanPauseMode default_fan_pause_mode = 10
optional FanPauseRuntime default_fan_pause_runtime = 11
optional uint32 fan_pause_runtime_limited_duration_s = 12

Disable temperature control. May be dangerous. DEPRECATED: Since Braiins OS 24.XX it is not possible to disable cooling mode.

Used in: CoolingConfiguration

optional double fan_speed_ratio = 1
User defined fan speed expressed as a ratio between 0.0 and 1.0 where 0.0 means completely turned off and 1.0 means running at full speed possible

Used in: CoolingConfiguration, SetCoolingModeRequest, SetCoolingModeResponse

optional Temperature hot_temperature = 1
optional Temperature dangerous_temperature = 2
optional Temperature target_temperature = 3

Used in: CoolingConfiguration, SetCoolingModeRequest, SetCoolingModeResponse

optional Temperature hot_temperature = 1
optional Temperature dangerous_temperature = 2
optional Temperature target_temperature = 3

Fans are kept at a fixed, user-defined speed, no matter the temperature.

Used in: CoolingConfiguration, SetCoolingModeRequest, SetCoolingModeResponse

optional double fan_speed_ratio = 1
User defined fan speed expressed as a ratio between 0.0 and 1.0 where 0.0 means completely turned off and 1.0 means running at full speed possible
optional Temperature hot_temperature = 2
Temperature threshold at which the fans start to run at 100%.
optional Temperature dangerous_temperature = 3
Temperature threshold at which BOSMiner shuts down in order to prevent overheating and damaging the miner.
optional Temperature target_temperature = 4
Temperature that the miner will try to maintain when power scaling is enabled
optional uint32 minimum_required_fans = 5
Minimum number of fans required to have BOSminer operational.
optional PauseMode pause_mode = 6
Pause mode

Used in: CoolingConstraints

COOLING_MODE_UNSPECIFIED = 0
COOLING_MODE_AUTO = 1
COOLING_MODE_MANUAL = 2
COOLING_MODE_DISABLED = 3
COOLING_MODE_IMMERSION = 4
COOLING_MODE_HYDRO = 5

optional bool enabled = 1
Flag if Dynamic Performance Scaling is enabled
optional Power power_step = 2
Dynamic Performance Scaling power step
optional TeraHashrate hashrate_step = 3
Dynamic Performance Scaling hashrate step
optional Power min_power_target = 4
Dynamic Performance Scaling minimal power target
optional TeraHashrate min_hashrate_target = 5
Dynamic Performance Scaling minimal hashrate target
optional bool shutdown_enabled = 6
Flag if shutdown for Dynamic Performance Scaling is enabled
optional Hours shutdown_duration = 7
Dynamic Performance Scaling shutdown duration
optional DPSMode mode = 8
Dynamic Performance Scaling mode
optional uint32 on_start_target_percent = 9
Initial target for Dynamic Performance Scaling in percent

optional PowerConstraints power_step = 1
Dynamic Performance Scaling power step constraints
optional HashrateConstraints hashrate_step = 2
Dynamic Performance Scaling hashrate step constraints
optional PowerConstraints min_power_target = 3
Dynamic Performance Scaling minimal power target constraints
optional HashrateConstraints min_hashrate_target = 4
Dynamic Performance Scaling minimal hashrate target constraints
optional BooleanConstraint shutdown_enabled = 5
Dynamic Performance Scaling enabled shutdown default value
optional DurationConstraints shutdown_duration = 6
Dynamic Performance Scaling shutdown duration constraints
optional BooleanConstraint enabled = 7
Dynamic Performance Scaling enabled default value
DPSMode mode = 8
Dynamic Performance Scaling default mode
optional UInt32Constraints on_start_target_percent = 9
Initial target for Dynamic Performance Scaling in percent

Used in: DPSTarget, SetDPSResponse

optional TeraHashrate hashrate_step = 1
Dynamic Performance Scaling hashrate step
optional TeraHashrate min_hashrate_target = 2
Dynamic Performance Scaling minimal hashrate target

Used in: DPSConfiguration, DPSConstraints, SetDPSRequest, SetDPSResponse

DPS_MODE_UNSPECIFIED = 0
DPS_MODE_NORMAL = 1
DPS_MODE_BOOST = 2

Used in: DPSTarget, SetDPSResponse

optional Power power_step = 1
Dynamic Performance Scaling power step
optional Power min_power_target = 2
Dynamic Performance Scaling minimal power target

Used in: SetDPSRequest

oneof target
- DPSPowerTarget power_target = 1
  Power target settings for Dynamic Performance Scaling
- DPSHashrateTarget hashrate_target = 2
  Hashrate target settings for Dynamic Performance Scaling

Used in: AutoUpgradeSchedule

optional UpgradeTime time = 1

Represents a day of the week.

Used in: WeeklySchedule

DAY_OF_WEEK_UNSPECIFIED = 0
The day of the week is unspecified.
DAY_OF_WEEK_MONDAY = 1
Monday
DAY_OF_WEEK_TUESDAY = 2
Tuesday
DAY_OF_WEEK_WEDNESDAY = 3
Wednesday
DAY_OF_WEEK_THURSDAY = 4
Thursday
DAY_OF_WEEK_FRIDAY = 5
Friday
DAY_OF_WEEK_SATURDAY = 6
Saturday
DAY_OF_WEEK_SUNDAY = 7
Sunday

Used in: NetworkConfiguration, SetNetworkConfigurationRequest

(message has no fields)

Used in: CoolingConstraints

double default = 1
double min = 2
double max = 3

Used in: DPSConstraints

optional Hours default = 1
optional Hours min = 2
optional Hours max = 3

Used in: MinerError

string code = 1
string reason = 2
string hint = 3

LicenseType type = 1
License type
string contract_name = 2
Contract name
optional BasesPoints dev_fee = 3
Defines how much DevFee should be generated by the device.

Used in: CoolingConstraints

FAN_PAUSE_MODE_UNSPECIFIED = 0
FAN_PAUSE_MODE_AUTO = 1
FAN_PAUSE_MODE_MANUAL = 2

Used in: CoolingConstraints, ManualPauseMode

FAN_PAUSE_RUNTIME_UNSPECIFIED = 0
FAN_PAUSE_RUNTIME_LIMITED = 1
FAN_PAUSE_RUNTIME_INDEFINITE = 2

Structure which contain info about one specific miner fan.

Used in: GetCoolingStateResponse

optional uint32 position = 1
Fan positions/ID
uint32 rpm = 2
Actual fan RPM (Revolutions/Rotation Per Minute)
optional double target_speed_ratio = 3
Actual fan speed ratio(PWM) in range 0.0 - 1.0

Structure for fixed share ratio load balance strategy Fixed share ratio is value between 0.0 to 1.0 where 1.0 represents that all work is generated from the group

Used in: PoolGroup, PoolGroupConfiguration

double value = 1

Used in: FrequencyConstraints, Hashboard, HashboardConfig, HashboardPerformanceConfiguration, HashboardPerformanceSettings, ManualPerformanceMode, MinerEfficiencyPoint

double hertz = 1

Used in: HashboardConstraints

optional Frequency default = 1
optional Frequency min = 2
optional Frequency max = 3

Used in: GetMinerDetailsResponse, HashrateTargetProfile, PowerTargetProfile, RealHashrate, WorkSolverStats

double gigahash_per_second = 1

Structure to handle HB details

Used in: GetHashboardsResponse

string id = 1
Hashboard ID
bool enabled = 2
Flag if HB is enabled
optional google.protobuf.UInt32Value chips_count = 3
Number of chips
optional Voltage current_voltage = 4
Current HB voltage in volts
optional Frequency current_frequency = 5
Current HB frequency in Hz
optional TemperatureSensor highest_chip_temp = 6
Highest chip temperature
optional Temperature board_temp = 7
Board temperature
optional WorkSolverStats stats = 8
Hashboard stats
optional string model = 9
Hashboard model
optional Temperature lowest_inlet_temp = 10
Lowest inlet temperature
optional Temperature highest_outlet_temp = 11
Highest outlet temperature
optional string serial_number = 12
Hashboard serial number
optional string board_name = 13
Hashboard board name
optional string chip_type = 14
Hashboard chip type
optional Temperature lowest_water_inlet_temp = 15
Lowest water inlet temperature (hydro cooling only)
optional Temperature highest_water_outlet_temp = 16
Highest water outlet temperature (hydro cooling only)

Used in: HashboardPerformanceConfiguration

string id = 1
Hashboard id
optional bool enabled = 2
Flag if HB si enabled
optional Frequency frequency = 3
Hashboard frequency
optional Voltage voltage = 4
Hashboard voltage

repeated string hashboard_ids = 1
List of possible HB indices
optional BooleanConstraint enabled = 2
Default value for flag if hashboards are enabled
optional FrequencyConstraints frequency = 3
HB frequency constraints
optional VoltageConstraints voltage = 4
HB frequency constraints
optional UInt32Constraints quick_ramping_time_s = 5
Quick ramping time constraints in seconds. Used in curtailments

Used in: DisableHashboardsResponse, EnableHashboardsResponse

string id = 1
Hashboard ID
bool is_enabled = 2
Flag if hashboard is enabled or not

optional Frequency global_frequency = 1
Common frequency for all HB
optional Voltage global_voltage = 2
Common voltage for all HB
repeated HashboardConfig hashboards = 3
Per hashboard frequency/voltage. It has higher priority than global one
optional uint32 quick_ramping_time_up_s = 4
Quick ramping time up in seconds. Used in curtailments
optional uint32 quick_ramping_time_down_s = 5
Quick ramping time down in seconds. Used in curtailments

Used in: ManualPerformanceMode

string id = 1
Hashboard id
optional Frequency frequency = 2
Hashboard frequency
optional Voltage voltage = 3
Hashboard voltage

Used in: DPSConstraints, TunerConstraints

optional TeraHashrate default = 1
optional TeraHashrate min = 2
optional TeraHashrate max = 3

Used in: TunerPerformanceMode

optional TeraHashrate hashrate_target = 1
Hashrate target

Used in: GetTunerStateResponse

optional HashrateTargetProfile profile = 1
Currently used profile
optional TeraHashrate current_target = 2
Current hashrate target

Structure to handle hashrate target profile

Used in: HashrateTargetModeState, ListTargetProfilesResponse

optional google.protobuf.Timestamp created = 1
Creation timestamp
optional TeraHashrate target = 2
Tuned hashrate target
optional GigaHashrate measured_hashrate = 3
Measured hashrate
optional Power estimated_power_consumption = 4
Estimated power consumption

Used in: DPSConfiguration, DurationConstraints, SetDPSRequest, SetDPSResponse

uint32 hours = 1

Used in: GetNetworkInfoResponse

string address = 1
string netmask = 2

Used in: ExpiredLicense, ValidLicense

LICENSE_TYPE_UNSPECIFIED = 0
LICENSE_TYPE_STANDARD = 1
LICENSE_TYPE_CUSTOM = 2

(message has no fields)

Response with locate device status

Used as response type in: ActionsService.GetLocateDeviceStatus, ActionsService.SetLocateDeviceStatus

bool enabled = 1

Supported log types for download

Used in: GetLogRequest

LOG_TYPE_UNSPECIFIED = 0
LOG_TYPE_ERRORS = 1
Bosminer error logs
LOG_TYPE_BOSMINER = 2
Bosminer logs
LOG_TYPE_BOSER = 3
Boser logs
LOG_TYPE_MONITOR = 4
Monitor logs
LOG_TYPE_SYSLOG = 5
System logs
LOG_TYPE_DMESG = 6
Kernel ring buffer (dmesg)

Manual pause mode runs with defined fixed fans speed and either turns off after a certain period of time or runs indefinitely according to fan_runtime settings

Used in: PauseMode

optional double pause_cooldown_fan_speed_ratio = 1
User defined pause cooldown fan speed expressed as a ratio between 0.0 and 1.0 where 0.0 means completely turned off and 1.0 means running at full speed possible
optional FanPauseRuntime fan_pause_runtime = 2
Controls how long fans run at the fixed speed before turning off. 1 = FAN_PAUSE_RUNTIME_LIMITED - fans run for a limited duration (see `fan_pause_runtime_limited_duration_s` in `CoolingConstraints`) then turn off 2 = FAN_PAUSE_RUNTIME_INDEFINITE - fans run indefinitely at the fixed speed until miner is resumed

Used in: PerformanceMode

optional Frequency global_frequency = 1
Global hashboard frequency
optional Voltage global_voltage = 2
Global hashboard voltage
repeated HashboardPerformanceSettings hashboards = 3
Per hashboard frequency/voltage. It has higher priority than global one

Used in: WorkSolverStats

double megahash_per_second = 1

Used in: MinerIdentity

MINER_BRAND_UNSPECIFIED = 0
MINER_BRAND_ANTMINER = 1
MINER_BRAND_WHATSMINER = 2

Single point on the miner efficiency curve

Used in: GetMinerEfficiencyProfileResponse

uint32 quality = 1
Number of tuned profiles used to interpolate the curve from
optional Power power_target = 2
Power target
optional Power consumption = 3
Estimated power consumption
uint32 fan_speed = 4
Estimated fan speed expressed as a value between 0 and 100 (PWM)
optional Temperature outlet_temp = 5
Estimated outlet temperature
optional Temperature ambient_temp = 6
Estimated ambient temperature
optional TeraHashrate hashrate = 7
Estimated hashrate
optional Frequency frequency = 8
Estimated frequency
optional Voltage voltage = 9
Estimated voltage

Used in: GetErrorsResponse

string timestamp = 1
string message = 2
repeated ErrorCode error_codes = 3
repeated Component components = 4

MinerBrand brand = 1
MinerModel model = 2
Deprecated: Use miner_model instead. This field is no longer supported.
string name = 3
string miner_model = 4

Deprecated: This enumeration is not longer maintained

Used in: MinerIdentity

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

Used in: GetMinerStatsResponse

optional Power approximated_consumption = 1
Miner approximated power consumption.
optional PowerEfficiency efficiency = 2
Miner power efficiency

Used in: GetMinerDetailsResponse, GetMinerStatusResponse

MINER_STATUS_UNSPECIFIED = 0
MINER_STATUS_NOT_STARTED = 1
MINER_STATUS_NORMAL = 2
MINER_STATUS_PAUSED = 3
MINER_STATUS_SUSPENDED = 4
MINER_STATUS_RESTRICTED = 5

Used in: AutoUpgradeSchedule

optional uint32 day_of_month = 1
Artificially limited to 1-28 to cover all months
optional UpgradeTime time = 2

Used in: GetNetworkConfigurationResponse, SetNetworkConfigurationResponse

oneof protocol
Network protocol
- Dhcp dhcp = 1
- Static static = 2
string hostname = 3
Hostname

Used in: GetNetworkInfoResponse

NETWORK_PROTOCOL_UNSPECIFIED = 0
NETWORK_PROTOCOL_DHCP = 1
NETWORK_PROTOCOL_STATIC = 2

uint32 time_to_restricted = 1
BOS Initialization timeout - number of seconds elapsed since bosminer start i.e., number of seconds BOS will start mining in restricted mode burning 5% of hashrate For more, see Section 3.10 of https://braiins.com/os/plus/license

Pause mode to control fans behaviour after you pause the miner

Used in: CoolingAutoMode, CoolingManualMode

oneof mode
- AutoPauseMode auto = 1
- ManualPauseMode manual = 2

Used as response type in: PerformanceService.GetActivePerformanceMode, PerformanceService.SetPerformanceMode

Used as field type in: SetPerformanceModeRequest

oneof mode
- ManualPerformanceMode manual_mode = 1
- TunerPerformanceMode tuner_mode = 2

Supported platforms

PLATFORM_UNSPECIFIED = 0
PLATFORM_AM1_S9 = 1
PLATFORM_AM2_S17 = 2
PLATFORM_AM3_BBB = 3
PLATFORM_AM3_AML = 4
PLATFORM_STM32MP157C_II1_AM2 = 5
PLATFORM_CVITEK_BM1_AM2 = 6
PLATFORM_ZYNQ_BM3_AM2 = 7
PLATFORM_STM32MP157C_II2_BMM1 = 8

Structure handle information about configured pool

Used in: PoolGroup

string uid = 1
Pool connection id
string url = 2
Pool connection URL
string user = 3
Pool connection user
bool enabled = 4
Flag if pool connection is enabled
bool alive = 5
Flag if pool is alive
bool active = 6
Flag if pool is active (running)
optional PoolStats stats = 7
Pool stats

Structure handle information about configured pool

Used in: PoolGroupConfiguration

optional string uid = 1
Pool connection id If this struct is used when creating a new Pool Configuration, this field must not be specified (it will be generated) If this struct is used when updating an existing configuration, this field must be specified and represents unique id of pool which will be updated
string url = 2
Pool connection URL
string user = 3
Pool connection user
optional string password = 4
Pool connection password if set
optional bool enabled = 5
Flag if pool connection is enabled

Structure handle all pool group details

Used in: GetPoolGroupsResponse

string name = 1
Group name
oneof strategy
Load balancing strategy
- Quota quota = 2
- FixedShareRatio fixed_share_ratio = 3
repeated Pool pools = 4
Group pools
string uid = 5
Group id

Structure handle configured mining group

Used in: CreatePoolGroupRequest, CreatePoolGroupResponse, GetMinerConfigurationResponse, SetPoolGroupsRequest, SetPoolGroupsResponse, UpdatePoolGroupRequest, UpdatePoolGroupResponse

optional string uid = 1
Group id gRPC: If this struct is used when creating a new Pool Group, this field must not be specified (it will be generated) gRPC: If this struct is used when updating an existing Pool Group, this field must be specified and represents unique id of Pool group which will be updated REST: If this struct is used when creating a new Pool Group, this field must not be specified (it will be generated) REST: If this struct is used when updating an existing Pool Group, this field must not be specified, uid in URL must be specified and represents unique id of Pool group which will be updated
string name = 2
Group name
oneof load_balance_strategy
Group load balance strategy
- Quota quota = 3
- FixedShareRatio fixed_share_ratio = 4
repeated PoolConfiguration pools = 5
Group pools

Structure handle pool statistics

Used in: GetMinerStatsResponse, Pool

uint64 accepted_shares = 1
Accepted shares
uint64 rejected_shares = 2
Rejected shares
uint64 stale_shares = 3
Stale shares
uint64 last_difficulty = 4
Last difficulty
uint64 best_share = 5
Best share (deprecated: may overflow for values > 2^64-1, use best_share_str instead)
uint64 generated_work = 6
Generated work
optional google.protobuf.Timestamp last_share_time = 7
Last share time
string best_share_str = 8
Best share as decimal string

Used in: DPSConfiguration, DPSPowerTarget, DecrementPowerTargetRequest, HashrateTargetProfile, IncrementPowerTargetRequest, MinerEfficiencyPoint, MinerPowerStats, PowerConstraints, PowerTargetMode, PowerTargetModeState, PowerTargetProfile, SetPowerTargetRequest, SetPowerTargetResponse, TunerConfiguration

uint64 watt = 1

Used in: DPSConstraints, TunerConstraints

optional Power default = 1
optional Power min = 2
optional Power max = 3

Used in: MinerPowerStats

double joule_per_terahash = 1

Used in: TunerPerformanceMode

optional Power power_target = 1
Power target

Used in: GetTunerStateResponse

optional PowerTargetProfile profile = 1
current power target profile
optional Power current_target = 2
Current power target

Structure to handle power target profile

Used in: ListTargetProfilesResponse, PowerTargetModeState

optional google.protobuf.Timestamp created = 1
Creation timestamp
optional Power target = 2
Tuned power target
optional GigaHashrate measured_hashrate = 3
Measured hashrate
optional Power estimated_power_consumption = 4
Estimated power consumption

Used in: CreatePoolGroupRequest, DecrementHashrateTargetRequest, DecrementPowerTargetRequest, DisableHashboardsRequest, EnableHashboardsRequest, IncrementHashrateTargetRequest, IncrementPowerTargetRequest, RemovePoolGroupRequest, SetCoolingModeRequest, SetDPSRequest, SetDefaultHashrateTargetRequest, SetDefaultPowerTargetRequest, SetDefaultQuickRampingRequest, SetHashrateTargetRequest, SetImmersionModeRequest, SetPerformanceModeRequest, SetPoolGroupsRequest, SetPowerTargetRequest, SetQuickRampingRequest, SetRelativeTargetRequest, UpdatePoolGroupRequest

optional google.protobuf.UInt32Value version = 1
PSU hardware version identifier
optional google.protobuf.UInt32Value fw_version = 2
PSU firmware version identifier
optional string serial_number = 3
PSU serial number (e.g. "DGAH335BDJDJG0782")
optional string model_name = 4
PSU model/version name in human-readable form (e.g. "APW121215b")
optional Voltage min_voltage = 5
Minimal voltage that can be set in volts
optional Voltage max_voltage = 6
Maximal voltage that can be set in volts

Used as response type in: PerformanceService.SetDefaultQuickRamping, PerformanceService.SetQuickRamping

uint32 up_s = 1
Quick ramping time up in seconds when RESUMING the miner. Sets how fast the miner will power up. Used in curtailments
uint32 down_s = 2
Quick ramping time down in seconds when PAUSING the miner. Sets how fast the miner will power off. Used in curtailments

Structure for quota load balance strategy

Used in: PoolGroup, PoolGroupConfiguration

uint32 value = 1

Structure which contains HB real hashrate stats.

Used in: WorkSolverStats

optional GigaHashrate last_5s = 1
optional GigaHashrate last_15s = 2
optional GigaHashrate last_30s = 3
optional GigaHashrate last_1m = 4
optional GigaHashrate last_5m = 5
optional GigaHashrate last_15m = 6
optional GigaHashrate last_30m = 7
optional GigaHashrate last_1h = 8
optional GigaHashrate last_24h = 9
optional GigaHashrate since_restart = 10

Enum to specify the reference point for a relative power/hashrate target.

Used in: SetRelativeTargetRequest

RELATIVE_TARGET_REFERENCE_UNSPECIFIED = 0
Unspecified
RELATIVE_TARGET_REFERENCE_NOMINAL = 1
Use nominal (sticker) power/hashrate target as the reference
RELATIVE_TARGET_REFERENCE_MIN = 2
Use minimal power/hashrate target as the reference
RELATIVE_TARGET_REFERENCE_MAX = 3
Use maximal power/hashrate target as the reference
RELATIVE_TARGET_REFERENCE_CURRENT = 4
Use current power/hashrate target as the reference

Save action for different operations

SAVE_ACTION_UNSPECIFIED = 0
SAVE_ACTION_SAVE = 1
SAVE_ACTION_SAVE_AND_APPLY = 2
SAVE_ACTION_SAVE_AND_FORCE_APPLY = 3

Used in: TemperatureSensor

SENSOR_LOCATION_UNSPECIFIED = 0
SENSOR_LOCATION_CHIP = 1
SENSOR_LOCATION_PCB = 2

Response for set hashrate target action.

Used as response type in: PerformanceService.DecrementHashrateTarget, PerformanceService.IncrementHashrateTarget, PerformanceService.SetDefaultHashrateTarget, PerformanceService.SetHashrateTarget, PerformanceService.SetRelativeHashrateTarget

optional TeraHashrate hashrate_target = 1
New value of hashrate target

Response for set power target action.

Used as response type in: PerformanceService.DecrementPowerTarget, PerformanceService.IncrementPowerTarget, PerformanceService.SetDefaultPowerTarget, PerformanceService.SetPowerTarget, PerformanceService.SetRelativePowerTarget

optional Power power_target = 1
New value of power target

Request for setting power/hashrate target relative to a reference value

Used as request type in: PerformanceService.SetRelativeHashrateTarget, PerformanceService.SetRelativePowerTarget

SaveAction save_action = 1
Save action
double percentage = 2
Percentage value to set (e.g., 85.5 for 85.5%)
RelativeTargetReference reference = 3
Reference point from which the percentage is calculated

Used in: NetworkConfiguration, SetNetworkConfigurationRequest

string address = 1
IP address
string netmask = 2
Netmask
string gateway = 3
Gateway
repeated string dns_servers = 4
DNS servers

Enumeration for support archive format

Used in: GetSupportArchiveRequest

SUPPORT_ARCHIVE_FORMAT_UNSPECIFIED = 0
SUPPORT_ARCHIVE_FORMAT_ZIP = 1
Compressed zip format
SUPPORT_ARCHIVE_FORMAT_BOS = 2
BOS custom format
SUPPORT_ARCHIVE_FORMAT_ZIP_ENCRYPTED = 3
Compressed encrypted zip format

Used in: SystemUpgradeRequest

uint64 size = 1
Firmware size (bytes)
string hash = 2
Firmware hash (SHA256 hex encoded)
bool discard_settings = 3
Flag if should discard settings (default is false and keep settings)
bool disable_cleanup = 4
Flag if should disable cleanup of directory, in which uploaded firmware is stored (default is false and do cleanup)

Used in: CoolingAutoMode, CoolingHydroMode, CoolingImmersionMode, CoolingManualMode, Hashboard, MinerEfficiencyPoint, TemperatureConstraints, TemperatureSensor

double degree_c = 1

Used in: CoolingConstraints

optional Temperature default = 1
optional Temperature min = 2
optional Temperature max = 3

Used in: GetCoolingStateResponse, Hashboard

optional uint32 id = 1
Sensor id
SensorLocation location = 2
Sensor location
optional Temperature temperature = 3
Temperature

Used in: DPSConfiguration, DPSHashrateTarget, DecrementHashrateTargetRequest, HashrateConstraints, HashrateTargetMode, HashrateTargetModeState, HashrateTargetProfile, IncrementHashrateTargetRequest, MinerEfficiencyPoint, SetHashrateTargetRequest, SetHashrateTargetResponse, TunerConfiguration

double terahash_per_second = 1

optional bool enabled = 1
Flag if tuner is enabled
optional TunerMode tuner_mode = 2
Tuner mode
optional Power power_target = 3
Tuner power target
optional TeraHashrate hashrate_target = 4
Tuner hashrate target

optional PowerConstraints power_target = 1
Tuner power target mode constraints
optional HashrateConstraints hashrate_target = 2
Tuner hashrate target mode constraints
optional BooleanConstraint enabled = 3
Tuner enabled enabled default value
TunerMode default_mode = 4
Default tuner mode

Used in: TunerConfiguration, TunerConstraints

TUNER_MODE_UNSPECIFIED = 0
TUNER_MODE_POWER_TARGET = 1
TUNER_MODE_HASHRATE_TARGET = 2

Used in: PerformanceMode

oneof target
- PowerTargetMode power_target = 1
  Tuner power target
- HashrateTargetMode hashrate_target = 2
  Tuner hashrate target

Used in: GetTunerStateResponse

TUNER_STATE_UNSPECIFIED = 0
TUNER_STATE_DISABLED = 1
TUNER_STATE_STABLE = 2
TUNER_STATE_TUNING = 3
TUNER_STATE_ERROR = 4
TUNER_STATE_CONTINUOUS = 5
TUNER_STATE_PREHEAT = 6

Used in: CoolingConstraints, DPSConstraints, HashboardConstraints

uint32 default = 1
uint32 min = 2
uint32 max = 3

Used in: DailySchedule, MonthlySchedule, WeeklySchedule

uint32 hours = 1
Hours of day in 24 hour format. Must be from 0 to 23.
uint32 minutes = 2
Minutes of hour of day. Must be from 0 to 59.
optional uint32 seconds = 3
Seconds of minutes of the time. Can be from 0 to 59.