AxeOS API Wrapper (@dominiklederer/axeos-api-wrapper)

A minimal, zero-dependency Node.js client library to query and validate telemetry metrics from Bitaxe Bitcoin solo miners running AxeOS / ESP-Miner firmware.

Developed and maintained by Dominik Lederer for Polarblocks.

Installation

Install the library using npm:

npm install @dominiklederer/axeos-api-wrapper

Quick Start Example

const { AxeOsClient } = require('@dominiklederer/axeos-api-wrapper');

// Initialize client with your Bitaxe miner's local IP address
const client = new AxeOsClient('192.168.1.150');

// Fetch and display full diagnostics (includes normalization and safety validation)
client.getDiagnostics()
  .then((diagnostics) => {
    console.log('--- Telemetry Diagnostics ---');
    console.log(`IP Address:  ${diagnostics.ipAddress}`);
    console.log(`Timestamp:   ${diagnostics.timestamp}`);
    console.log(`Hashrate:    ${diagnostics.metrics.hashrateGhs} GH/s`);
    console.log(`Temperature: ${diagnostics.metrics.temperatureC}°C`);
    console.log(`Voltage:     ${diagnostics.metrics.coreVoltageV} V`);
    
    console.log('\n--- Hardware Health Report ---');
    console.log(`Status:      ${diagnostics.diagnostics.isHealthy ? 'HEALTHY' : 'ANOMALOUS'}`);
    
    if (diagnostics.diagnostics.warnings.length > 0) {
      console.log('Warnings:');
      diagnostics.diagnostics.warnings.forEach(w => console.log(` - ${w}`));
    }
    
    if (diagnostics.diagnostics.alerts.length > 0) {
      console.log('\nAlerts:');
      diagnostics.diagnostics.alerts.forEach(a => console.warn(a));
    }
  })
  .catch((error) => {
    console.error('Error fetching diagnostics:', error.message);
  });

For more documentation and complete calibration guides, visit Polarblocks.