Device models¶

Pydantic models for device, overclock, and platform endpoints.

rainbowminer_api_client.models.devices ¶

Models for device-related endpoints.

Covers: /alldevices, /devices, /devicecombos, /getdeviceconfig, /ocprofiles, /cpuinfo, /sysinfo.

AllDevice ¶

Bases: RainbowMinerModel

An entry from /alldevices — a hardware device detected by RainbowMiner.

Attributes:

Name	Type	Description
`Type`	`str \| None`	Device type (`"Gpu"` or `"Cpu"`).
`Vendor`	`str \| None`	Vendor name (`"NVIDIA"`, `"AMD"`, `"INTEL"`).
`Model`	`str \| None`	Device model name.
`Name`	`str \| None`	Display name.
`Data`	`dict[str, Any] \| None`	Vendor-specific device data.

Device ¶

Bases: RainbowMinerModel

An entry from /devices — selected/enabled devices.

Attributes:

Name	Type	Description
`Type`	`str \| None`	Device type (`"Gpu"` or `"Cpu"`).
`Vendor`	`str \| None`	Vendor name (`"NVIDIA"`, `"AMD"`, `"INTEL"`).
`Model`	`str \| None`	Device model name.
`Name`	`str \| None`	Display name.

DeviceCombo ¶

Bases: RainbowMinerModel

An entry from /devicecombos.

Newer servers return a plain list of device-name strings (e.g. ["CPU", "GPU#0"]); this model is kept for forward-compatibility if the server ever returns structured objects.

DeviceConfigEntry ¶

Bases: RainbowMinerModel

An entry from /getdeviceconfig.

Attributes:

Name	Type	Description
`Name`	`str`	Device or vendor name.
`Selected`	`bool`	Whether the device is selected for mining.
`Excluded`	`bool`	Whether the device is explicitly excluded.
`Cores`	`int \| None`	CPU core count (CPU entries only).
`Threads`	`int \| None`	CPU thread count (CPU entries only).

OCProfile ¶

Bases: RainbowMinerModel

An entry from /ocprofiles — an overclock profile.

Attributes:

Name	Type	Description
`Name`	`str`	Profile name.
`Device`	`str`	Target device label.
`PowerLimit`	`float \| int \| str \| None`	Power limit percentage.
`ThermalLimit`	`float \| int \| str \| None`	Thermal limit in degrees Celsius.
`MemoryClockBoost`	`float \| int \| str \| None`	Memory clock offset in MHz.
`CoreClockBoost`	`float \| int \| str \| None`	Core clock offset in MHz.
`LockVoltagePoint`	`float \| int \| str \| None`	Locked voltage point in mV.
`LockMemoryClock`	`float \| int \| str \| None`	Locked memory clock in MHz.
`LockCoreClock`	`float \| int \| str \| None`	Locked core clock in MHz.