Rest control

README.md

@@ -53,6 +53,17 @@ After this, you can use `sudo satellite-update` to change the version it has ins
 
 Note: This script will create a new user called `satellite`, which Satellite will be run as and will own the configuration.
 
+### REST API
+
+The default rest port is 9999
+a GET request to `http://Satellite-IP:9999/api/ip` will return the current target ip
+a GET request to `http://Satellite-IP:9999/api/port` will return the current target ip
+
+a POST request to `http://Satellite-IP:9999/api/ip` with a valid ip will connect the sattelite to that ip
+a POST request to `http://Satellite-IP:9999/api/port` with a valid port number will connect the sattelite to that port
+
+hostenames are not yet suporrted
+
 ## Development
 
 NodeJS 16 is required

pi-image/satellite-config

@@ -5,4 +5,7 @@
 COMPANION_IP=127.0.0.1
 
 # If you are connecting through a router or firewall which has remapped the port, you will need to change that here to match
-COMPANION_PORT=16622
+COMPANION_PORT=16622
+
+#PORT FOR THE REST server
+REST_PORT=9999

pi-image/satellite.service

@@ -8,7 +8,7 @@ Type=simple
 User=satellite
 WorkingDirectory=/usr/local/src/companion-satellite
 EnvironmentFile=/boot/satellite-config
-ExecStart=/opt/fnm/aliases/default/bin/node /usr/local/src/companion-satellite/dist/main.js $COMPANION_IP $COMPANION_PORT
+ExecStart=/opt/fnm/aliases/default/bin/node /usr/local/src/companion-satellite/dist/main.js $COMPANION_IP $COMPANION_PORT $REST_PORT
 Restart=on-failure
 KillSignal=SIGINT
 TimeoutStopSec=60

pi-image/update.sh

@@ -27,6 +27,16 @@ cp pi-image/50-satellite.rules /etc/udev/rules.d/
 
 # update startup script
 cp pi-image/satellite.service /etc/systemd/system
+
+# ADD REST_PORT to old config files
+if grep -q REST_PORT /boot/satellite-config; then
+echo "config ok"
+else
+echo "
+#PORT FOR THE REST server
+REST_PORT=9999" >> /boot/satellite-config
+fi
+
 systemctl daemon-reload
 
 # install some scripts

src/cards.ts

@@ -51,9 +51,25 @@ export class CardGenerator {
 		context2d.fillStyle = '#ffffff'
 
 		context2d.fillText(`Remote: ${remoteIp}`, 10, height - 10)
-		context2d.fillText(`Status: ${status}`, 10, height - 30)
+		context2d.fillText(`Local: ${getIPAddress()}`, 10, height - 30)
+		context2d.fillText(`Status: ${status}`, 10, height - 50)
 
 		// return result
 		return Buffer.from(context2d.getImageData(0, 0, width, height).data)
 	}
 }
+//#TODO: make llocal ip reactive
+import { networkInterfaces } from 'os'
+function getIPAddress() {
+	for (let devName in networkInterfaces()) {
+		let iface = networkInterfaces()[devName];
+		if (iface) {
+			for (let i = 0; i < iface.length; i++) {
+				let alias = iface[i];
+				if (alias.family === 'IPv4' && alias.address !== '127.0.0.1' && !alias.internal)
+					return alias.address;
+			}
+		}
+	}
+	return '0.0.0.0';
+}

src/main.ts

@@ -4,14 +4,18 @@ import { CompanionSatelliteClient } from './client'
 import { DeviceManager } from './devices'
 import { DEFAULT_PORT } from './lib'
 
+import { RestServer } from './rest'
+import * as fs from 'fs'
+
 const cli = meow(
 	`
 	Usage
-	  $ companion-satellite hostname [port]
+	  $ companion-satellite hostname [port] [REST port]
 
 	Examples
 	  $ companion-satellite 192.168.1.100
 	  $ companion-satellite 192.168.1.100 16622
+	  $ companion-satellite 192.168.1.100 16622 9999
 `,
 	{}
 )
@@ -21,25 +25,73 @@ if (cli.input.length === 0) {
 }
 
 let port = DEFAULT_PORT
+let rest_port = 9999
 if (cli.input.length > 1) {
 	port = Number(cli.input[1])
 	if (isNaN(port)) {
 		cli.showHelp(1)
 	}
+	if (cli.input.length > 2) {
+		rest_port = Number(cli.input[2])
+		if (isNaN(rest_port)) {
+			cli.showHelp(1)
+		}
+	}
 }
 
 console.log('Starting')
 
 const client = new CompanionSatelliteClient({ debug: true })
 const devices = new DeviceManager(client)
+const server = new RestServer(client, rest_port)
 
 client.on('log', (l) => console.log(l))
 client.on('error', (e) => console.error(e))
 
+client.on('ipChange', (newIP) => {
+	updateEnvironmentFile('/boot/satellite-config',
+		{ "COMPANION_IP": newIP, "COMPANION_PORT": String(client.port) })
+})
+
 exitHook(() => {
 	console.log('Exiting')
 	client.disconnect()
 	devices.close()
+	server.close()
 })
 
 client.connect(cli.input[0], port)
+
+function updateEnvironmentFile(filePath: string, changes: Record<string, string>): void {
+	fs.access(filePath, (err: any) => {
+		if (err) {
+			console.log(err)
+		} else {
+			fs.readFile(filePath, 'utf-8', function (err: any, data: string) {
+				if (err) {
+					console.error(err)
+				}
+				else {
+					let lines = data.split(/\r?\n/)
+
+					for (let i = 0; i < lines.length; i++) {
+						for (const key in changes) {
+							if (lines[i].startsWith(key)) {
+								lines[i] = key + '=' + changes[key]
+							}
+						}
+					}
+
+					let newData = lines.join('\n')
+
+					fs.writeFile(filePath, newData, 'utf-8', function (err: any) {
+						if (err) {
+							console.error(err)
+						}
+					});
+				}
+
+			})
+		}
+	})
+}

src/rest.ts

@@ -0,0 +1,100 @@
+import http = require('http')
+import net = require('net')
+import { CompanionSatelliteClient } from './client'
+
+export class RestServer {
+    private _cs_client: CompanionSatelliteClient
+    private _server: http.Server
+
+    constructor(client: CompanionSatelliteClient, port: Number) {
+
+        this._cs_client = client
+        // super()
+
+        this._server = http.createServer(async (req, res) => {
+            //set the request route
+            if (req.method === 'GET') {
+                console.log("api get: ", req.url)
+                switch (req.url) {
+                    //#TODO:add host case
+                    case ('/api/ip'): {
+                        res.writeHead(200, { "Content-Type": "application/json" })
+                        res.write(this._cs_client.host)
+                        res.end()
+                        break
+                    }
+                    case ('/api/port'): {
+                        res.writeHead(200, { "Content-Type": "application/json" })
+                        res.write(String(this._cs_client.port))
+                        res.end()
+                        break
+                    }
+                    default: {
+                        res.writeHead(204, { "Content-Type": "application/json" })
+                        res.end(JSON.stringify({ message: "Route not found" }))
+                        break
+                    }
+                }
+            }
+            if (req.method === 'POST') {
+                let body = ''
+                req.on('data', (data) => {
+                    body += data
+                })
+                req.on('end', () => {
+                    console.log("api post:", req.url, body)
+                    switch (req.url) {
+                        case ('/api/ip'): {
+                            if (net.isIP(body) != 0) {
+                                res.writeHead(200, { "Content-Type": "application/json" })
+                                res.end()
+                                this._cs_client.connect(body, this._cs_client.port)
+                            } else {
+                                res.writeHead(400, { "Content-Type": "application/json" })
+                                res.end(JSON.stringify({ message: "Malformed ip" }))
+                            }
+                            break
+                        }
+                        case ('/api/port'): {
+                            let port = Number(body)
+                            if (port && port > 0 && port < 65535) {
+                                res.writeHead(200, { "Content-Type": "application/json" })
+                                res.end()
+                                this._cs_client.connect(this._cs_client.host, port)
+                            } else {
+                                res.writeHead(400, { "Content-Type": "application/json" })
+                                res.end(JSON.stringify({ message: "bad port" }))
+                            }
+                            break
+                        }
+                        default: {
+                            res.writeHead(204, { "Content-Type": "application/json" })
+                            res.end(JSON.stringify({ message: "Route not found" }))
+                            break
+                        }
+                    }
+                })
+            }
+        })
+
+        this.open(port)
+    }
+
+    public open(port: Number) {
+        if (this._server.listening) { this.close() }
+        if (port != 0) {
+            this._server.listen(port, () => {
+                console.log(`REST server starting: port: ${port}`)
+            })
+        } else {
+            console.log("REST server not starting: port 0")
+        }
+
+    }
+
+    public close(): void {
+        this._server.closeAllConnections()
+        console.log("The rest server is closed")
+    }
+
+}