turing-pi-js v1.1.1

🤖 turing-pi-js

A JavaScript client for Turing Pi web API

ℹ️ Overview

📦 Prerequisites

• Node.js
• Turing Pi 2

This project is maintained by @PhearZero and is not associated with @turing-machines. This library is used to control a Turing Pi 2 from a JavaScript environment.

⚙️ Getting started

Install

npm -i turing-pi-js --save

Import

import {tpi} from 'turing-pi-js'
const BMC_API = '<Add-URL-to-BMC-API>'
const client = tpi(BMC_API)

Example Usage

// Get current power state for all Nodes
client.get('power').then(r=>console.log(r))
// Power On Node 1
client.set('power',{node1:1}).then(r=>console.log(r))

Find out more in the detailed usage

💾 Firmware

The current firmware, as of writing (v1.0.1, v0.1.0-ce), does not support Cross Origin Requests and requires a reverse proxy to connect from another machine. This library will work without a proxy when deployed locally on the Turing Pi Web Server

🔃 Reverse Proxy

Temporary fix until the firmware api becomes more stable. This template patches the response headers for using the library in the browser. The ENV variable for the Turing Pi BMC API is BMC_API in following template:

#/etc/nginx/templates/default.conf.template
server {
    listen       80;
    listen  [::]:80;
    server_name  localhost;
    
    location /api/bmc {
        proxy_pass   ${BMC_API};
        proxy_hide_header Content-Type;
        add_header Content-Type application/json;
        add_header Access-Control-Allow-Origin *;
    }
}

📗 Usage

✨ Create client

import {tpi} from 'turing-pi-js'
const BMC_API = '<Add-URL-to-BMC-API>'
const client = tpi(BMC_API)

🔧 Fetch Options

client.get('nodeinfo', {
    credentials: true,
})

🔌 Power

// Valid values are "0" or "1". "0" for OFF, "1" for ON.

// Get Power for all Nodes
client.get('power').then(r=>console.log(r))

// Set Power for any number of Nodes
client.set('power', {node1: 1, node2: 0, /* node3:0, node4:0 */}).then(r=>console.log(r))

⌨️ USB

// mode: Valid values are "0" or "1". "0" for Host, "1" for Device
// node: Valid values are "0", "1", "2", "3". Relating to slots Node1-4

// Get USB state from BMC
client.get('usb').then(r=>console.log(r))

// Set Power for any number of Nodes
client.set('usb', {mode: 0, node: 0}).then(r=>console.log(r))

ℹ️ Node Info

// Get Node Info
client.get('nodeinfo').then(r=>console.log(r))

ℹ️ BMC Info

// Get BMC Info
client.get('other').then(r=>console.log(r))

📂 SD Card Info

// Get SD card info
client.get('sdcard').then(r=>console.log(r))

🔃 Reset Network

// Reset network
client.set('network', {cmd: "reset"}).then(r=>console.log(r))

💾 Update Firmware

// Get the file contents
var input = document.querySelector('input[type="file"]')
// Upload firmware
client.set('firmware', {file: input.files[0]}).then(r=>console.log(r))