Référence de l’API des mineurs (port 4028)

Réponse rapide

Presque tous les mineurs ASIC exposent une API de gestion locale sur le port TCP 4028 — le « socket API » de cgminer/BMMiner/BOSminer. Vous envoyez un objet JSON d'une ligne comme {"command":"summary"} et recevez du JSON ; c'est ainsi que les outils de parc, pyasic et les tableaux de bord de surveillance lisent vos mineurs et (lorsque c'est permis) changent de pool, activent des cartes et règlent le tuning. Mais la MÊME commande se comporte différemment selon le firmware : l'Antminer d'origine est largement en lecture seule sur 4028 (les écritures passent par son CGI HTTP), BraiinsOS garde 4028 en lecture seule et déplace le contrôle vers gRPC, et la famille LuxOS implémente lecture+contrôle complets sur 4028 derrière un jeton de session. Cette référence est cette matrice — 50 commandes (25 de classe contrôle), chacune mappée sur Stock, la famille BraiinsOS, la famille LuxOS et DCENT_OS, avec les paramètres et une description d'une ligne, chaque ligne citée.

Comment la lire : la colonne « Accès » indique ce que la commande FAIT (lecture vs contrôle) ; les quatre colonnes de firmware indiquent COMMENT chaque famille l'expose — Read / Control sur le socket 4028, gRPC (la capacité vit sur le port gRPC 50051 de BraiinsOS, pas 4028), HTTP CGI (le firmware d'origine fait l'écriture via /cgi-bin), ou — (pas sur ce socket). Les commandes de contrôle de la famille LuxOS prennent un jeton de session comme premier paramètre (logon pour en obtenir un). Les colonnes DCENT_OS sont des CIBLES bêta (bêta publique en ligne depuis juillet 2026) visant une détection compatible cgminer pour que les outils existants fonctionnent tels quels — construites sur les épaules de cgminer, BOSminer et LuxOS, sans prétendre les surpasser. CSV/JSON gratuits sous CC BY 4.0.

Télécharger le CSV Télécharger le JSON API REST →

Commande	Accès	Stock Antminer	BraiinsOS-family	LuxOS-family	DCENT_OS
`version` Returns miner/API version (CGMiner version, API version string e.g. '3.7', Miner type, compile time). Primary tool-fingerprint call. Identity	lecture	Read	Read	Read	Beta
`summary` Top-level mining summary: Elapsed, GHS 5s / GHS av (or MHS av/5s), Accepted, Rejected, Hardware Errors, Utility, Found Blocks, Best Share, Device Hardware%/Rejected%. Status	lecture	Read	Read	Read	Beta
`stats` Detailed per-board statistics: per-chain chip counts (chain_acn), per-chain hashrate (chain_rate), chip status maps (chain_acs), temps (temp, temp2_*), fan RPM (fan1-4), total_rateideal, uptime. Status	lecture	Read	Read	Read	Beta
`pools` Lists configured pools with per-pool metrics: URL, Status (Alive/Dead), Priority, Quota, Accepted/Rejected, User, Stratum Active, Last Share Time/Difficulty, Pool Rejected%/Stale%. Pools	lecture	Read	Read	Read	Beta
`devs` Per-device (hashboard/ASC) report: status, temperature, hashrate, accepted/rejected, hardware errors per board. Devices	lecture	Read	Read	Read	Beta
`devdetails` Static hardware details per board: Model, Chips, Cores, Frequency, Voltage, Profile, Serial. Used for model identification. Devices	lecture	Read	Read	Read	Beta
`config` Basic configuration info: ASC count, pool count, active strategy, log interval, device code, OS. Config	lecture	Read	Read	Read	Beta
`edevs` (none (legacy '[old]' arg accepted)) Same as devs but excludes blacklisted/zombie devices. Cleaner board list for monitoring. Devices	lecture	Read	Read	Read	Beta
`estats` (none (legacy '[old]' arg accepted)) Same as stats but excludes zombie devices. Variety of model-specific miner stats. Status	lecture	Read	Read	Read	Beta
`coin` Current coin/algorithm info (hash method, current block diff, network diff). Placeholder/compatibility on many ASIC builds. Status	lecture	Read	Read	Read	Beta
`lcd` Compact one-shot general summary (originally for LCD displays). Compatibility placeholder on most ASIC firmware. Status	lecture	Read	—	Read	TBD
`check` (command_name) Reports whether a given command exists and the caller's access level for it. Used for capability discovery. Meta	lecture	Read	Read	Read	Beta
`asc` (board_id (n)) Detailed report for a single ASC (hashboard) by index. Devices	lecture	Read	Read	Read	Beta
`asccount` Returns the quantity of ASC devices (hashboards) detected. Devices	lecture	Read	Read	Read	Beta
`notify` Returns the device notification/error history (last share, temps, comms errors per device). Status	lecture	Read	Read	Read	Beta
`privileged` Reports whether the calling connection has privileged (write) access under the api-allow policy. Meta	lecture	Read	Read	Read	Beta
`pga` (n) Legacy: data for FPGA device n. Placeholder/empty on ASIC-only miners. Devices	lecture	Read	—	Read	TBD
`debug` (setting) Get/set the daemon debug verbosity flags (e.g. quiet, verbose, debug, rpc). Meta	lecture	Read	—	Read	TBD
`lockstats` Writes internal lock statistics to the log (build-dependent debug aid). Meta	lecture	Read	—	—	TBD
`switchpool` (n (pool index)) Switch the active pool to index n (raise to top priority). Pools	contrôle	HTTP CGI	gRPC	Control	TBD
`enablepool` (n) Enable (activate) pool n. Pools	contrôle	HTTP CGI	gRPC	Control	TBD
`disablepool` (n) Disable (deactivate) pool n. Pools	contrôle	HTTP CGI	gRPC	Control	TBD
`addpool` (url,user,password) Add a new pool (to the first group). On LuxOS the leading session_id is required. Pools	contrôle	HTTP CGI	gRPC	Control	TBD
`removepool` (n) Remove pool n. Pools	contrôle	HTTP CGI	gRPC	Control	TBD
`poolpriority` (n,n,n,... (priority order)) Set the priority order of all pools. Pools	contrôle	HTTP CGI	gRPC	Control	TBD
`poolquota` (n,q (pool,quota)) Set the load-balancing quota for pool n. Pools	contrôle	HTTP CGI	gRPC	Control	TBD
`save` ([file]) Persist the current configuration to disk (optionally to a named file). Config	contrôle	HTTP CGI	gRPC	Control	TBD
`restart` Restart the mining daemon (cgminer/bmminer/bosminer/luxminer) without rebooting the device. System	contrôle	HTTP CGI	gRPC	Control	TBD
`quit` Terminate the mining daemon process. System	contrôle	HTTP CGI	gRPC	Control	TBD
`ascenable` (n) Enable hashboard (ASC) n. Devices	contrôle	HTTP CGI	gRPC	Control	TBD
`ascdisable` (n) Disable hashboard (ASC) n. Devices	contrôle	HTTP CGI	gRPC	Control	TBD
`ascset` (n,opt[,val] (vendor-specific opcodes)) Set a vendor-specific ASC option. On Avalon/Canaan this carries the model-specific ascset opcodes (e.g. frequency, voltage, LED). Parameters are not portable across vendors. Devices	contrôle	HTTP CGI	gRPC	Control	TBD
`pgaenable` (n) Legacy: enable FPGA device n (placeholder on ASIC miners). Devices	contrôle	HTTP CGI	—	—	TBD
`pgadisable` (n) Legacy: disable FPGA device n (placeholder on ASIC miners). Devices	contrôle	HTTP CGI	—	—	TBD
`pgaidentify` (n) Legacy: blink the identify LED on FPGA device n. Devices	contrôle	HTTP CGI	—	—	TBD
`setconfig` (name,value) Set a global cgminer config value (e.g. queue, scantime, expiry). Config	contrôle	HTTP CGI	gRPC	Control	TBD
`zero` (which,summary (true/false)) Zero the named statistics counters; optional summary printout. Stats	contrôle	HTTP CGI	gRPC	Control	TBD
`hotplug` (n (seconds)) Set the hotplug device-scan interval (0 disables). System	contrôle	HTTP CGI	—	Control	TBD
`failover-only` (true\|false) Restrict work to the primary pool unless it is dead (failover-only mode). Pools	contrôle	HTTP CGI	gRPC	Control	TBD
`logon` Open a control session; returns SessionID. Single-session mutex: fails if a session already exists. SessionID is the FIRST parameter of every mutating command. (LuxOS-family model; BraiinsOS uses gRPC bearer token instead.) Session	contrôle	—	gRPC	Control	TBD
`logoff` (session_id) Close the active control session. Session	contrôle	—	gRPC	Control	TBD
`session` Report whether a control session is currently active. Session	lecture	—	—	Read	TBD
`kill` Force-terminate any active session (recover a stuck mutex). Session	contrôle	—	—	Control	TBD
`fans` Fan statistics: per-fan RPM, speed %, target %. Cooling	lecture	Read	Read	Read	Beta
`temps` Per-chain board and chip temperatures. Cooling	lecture	Read	Read	Read	Beta
`tempctrl` Temperature-control thresholds (target / hot / dangerous). Cooling	lecture	—	—	Read	TBD
`power` Get power consumption in watts (measured or estimated). Power	lecture	—	gRPC	Read	Beta
`profiles` List available tuning profiles (frequency/voltage operating points). Note: profile values are runtime operating points, not factory presets. Tuning	lecture	—	gRPC	Read	Beta
`profileset` (session_id,profile_name[,frequency_step,voltage_step,update_atm]) Set the active tuning profile for the miner/board. (BraiinsOS equivalent is a gRPC tuner call; stock has no socket equivalent.) Tuning	contrôle	—	gRPC	Control	TBD
`curtail` (session_id,sleep\|wakeup[,voltage_step,frequency_step,mode]) Demand-response sleep/wake control (curtailment). LuxOS exposes sleep/wakeup; an operator can pause hashing for grid events. (BraiinsOS pause/resume is gRPC.) Power	contrôle	—	gRPC	Control	TBD

Légende : Read lecture seule sur 4028 · Control écriture/contrôle sur 4028 · gRPC / HTTP CGI contrôle via une surface différente (gRPC 50051 de BraiinsOS / /cgi-bin d'origine) · Beta‡ cible bêta DCENT_OS · — / TBD pas sur ce socket. Les commandes de contrôle de la famille LuxOS nécessitent un jeton de session (logon).

Source : la Mining Bible de D-Central (PYASIC_COMPATIBILITY, rétro-ingénierie BraiinsOS et LuxOS) — citations par commande dans le CSV/JSON. Voir aussi la matrice des fonctionnalités de firmware, le protocole de pool Stratum V2 (distinct de ce socket local), et le flasheur web.

Produits, réparations et guides connexes

Dernière révision: 27 juillet 2026.