REST API: SetFanSpeed

[jbride]

HTTP Put API to set fan speed on a board

Path = "/api/v1/board/{serial}/fanspeed",
Response: JSON representation of SetFanSpeedResponse:

[jayrmotta]

Hey @jbride 👋

I've been working on a proof of concept to manage temperature and it adjusts fan speed + frequency, it's still WIP but when I read this discussion it got me puzzled.

As far as I understood about mujina it's meant to play the role of a control board, so what other client would be interested in adjusting fan speed remotely? An admin webapp? Also, how would we secure this endpoint?

I remember an issue AxeOS had in the past where malicious websites would sweep users network from their webpages and when they detected one of those hosts/IPs being AxeOS it would then proceed to send requests to change the configured pool username to a bitcoin address controlled by them. So, if this is meant for a web app being built to admin both the control and hash boards we would need to restrict requests coming from the same origin and maybe auth them as well.

[jbride]

One example of an external client interacting with these REST APIs could be Node-Red based flows running in Home Assistant.

Security related options for these REST endpoints would be similar to any other self-hosted HTTP based web app.
In addition, you could optionally choose to bind the mujina process to localhost only on startup.

[rkuester]

MIP-0001 makes fan speed a target_percent setpoint in the unified tree: leave it unset for automatic thermal control (the side @jayrmotta is building for the Bitaxe Gamma in #33), or write it for the manual override this thread proposed. Security (CSRF, origin, auth, localhost binding) is a separate topic in #43, not part of MIP-0001. Folding the API part into #57; closing as superseded.