The command line for MoaT
Project description
The MoaT
"MoaT" is an acronym of "Master of all Things", which is either aspirational or just plain pretentious. Take your pick.
If you assume that this repository contains the same stuff as a regular moat, i.e. a lot of water of questionable quality (plus whatever the castle's inhabitants wanted to get rid off), you might not be too far off the mark.
Well, except for the water.
Seriously …
The MoaT code comprises a lot of somewhat-opinionated code to control various IoT devices. Among those are photovoltaics, irrigation, door intercoms, and whatnot.
The core of MoaT is written in anyio-compatible asynchronous Python3, written with Structured Concurrency principles in mind.
Satellite microcontrollers typically run MicroPython, again heavily using structured async code: MicroPython supports taskgroups if you patch it lightly.
Structured what?
Structured Concurrency.
There's a Wikipedia article about it.
A good Pythonic introduction is here.
Repository Structure
The MoaT code is built using git submodules, corresponding to separate
moat-XXX
packages.
The top module contains the command-line front-end of MoaT. Any
MoaT code that can reasonably be controlled by a command line hooks into
it, by way of a _main
module with a cli
object, which should be an
asyncclick
group (or command).
The only mandatory submodule is "util". It contains a heap of semi-structured helper code which the rest of the MoaT infrastructure depends on. "moat-util" also has a command line; it serves as a convenient example for building your own extension, and exports a time-until-absolute-date calculator and a msgpack codec.
Modules
Libraries
-
dbus: an async DBus client.
-
gpio: a library to read and write GPIO lines.
-
modbus: an opinionated Modbus client and server library.
-
mqtt: a MQTT broker, client library, and client command line front-ends.
-
wire: a bidirectional link exchanging structured messages, with backends for serial and TCP.
-
micro: Support for MoaT sattelites running MicroPython
MoaT parts
-
main, util: See above.
-
kv: distributed masterless eventually-consistent key-value storage.
-
ems: Battery management, photovoltaics, …
-
src: MoaT source code management
MoaT-KV components
Moat-KV is a master-less distributed key-value storage system. It is resistant to partitioning and intended to be always-on. It will not block or lose updates in a partitioned network; inconsistent entries are re-synchronized upon reconnection.
"moat.kv" is currently named "distkv". Conversion to MoaT is planned.
-
kv-akumuli: Data storage to Akumuli, an efficient light-weight time series database
-
kv-gpio: Connecting Moat-KV and MoaT-GPIO
-
kv-hass: Use MoaT-KV as the MQTT back-end to Home Assistant
-
kv-inv: Network inventory management (hosts, networks, VLANs, links between hosts)
-
kv-knx: Link with KNX building automation networks
-
kv-owfs: Connecting 1wire sensors
-
kv-wago: A rudimentary interface for WAGO 330 controllers
MoaT-EMS components
EMS is an acronym for "Energy Management System".
-
ems-battery: Battery management
-
ems-inv: Inverter management
-
ems-sched: Energy storage scheduling
More will follow.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file moat-0.3.6.tar.gz
.
File metadata
- Download URL: moat-0.3.6.tar.gz
- Upload date:
- Size: 9.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.11.2
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9468a79947c084cdef3f77d00b46b7750b6a1b397ee790ef9987b72f80139a93 |
|
MD5 | 01b639d0a0928322277b6157f971daa4 |
|
BLAKE2b-256 | c4a327b179645b7ef8a38dd3ecddac5b4f29a3615af9a331d53f56de5ea4d130 |
File details
Details for the file moat-0.3.6-py3-none-any.whl
.
File metadata
- Download URL: moat-0.3.6-py3-none-any.whl
- Upload date:
- Size: 6.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.11.2
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | c054edb1c79fb03cbe469432b9a4a319876d74ffde9b88bdaee98086d830beff |
|
MD5 | 9de9845c2fe235b4961f2e6aa0bf7ba9 |
|
BLAKE2b-256 | 4c5d8fed0b46ea08b2ae05a639887734f412e5e00d2858a8953a6288416544c2 |