Skip to main content

Home/commercial automation server

Project description

AI generated picture of a tavern

Linux Single Board Computer badge DMX Python

Offline First GPLv3 Badge Pre-commit Badge Makefile Badge

Ten Year Project Pytest Ruff Poetry

Amidst the mists and fiercest frosts,
with stoutest wrists and loudest boasts,
He thrusts his fists against the posts,
And still insists he sees the ghosts.

Kaithem is Linux home/commercial automation server written in pure Python(3.10 and up). Not tested outside of Linux. Resource usage is low enough to run well on the Raspberry Pi.

You automate things by directly writing python and HTML via a web IDE, or by using the built-in Chandler module, which is a full web-based lighting aud audio control board with a visual programming language adding interactivity.

Installation 🌲

The careful text-books measure
(Let all who build beware!)
The load, the shock, the pressure
Material can bear.

First you'll need to get pipx if you haven't yet.

sudo apt install pipx
python3 -m pipx ensurepath

Next you can just install it right from PyPi! Be aware that pipx takes a while on a raspberry pi.

pipx install --verbose kaithem

kaithem-scripts root-install-system-dependencies

System Configuration

So, when the buckled girder
Lets down the grinding span,
The blame of loss, or murder,
Is laid upon the man.
Not on the Stuff — the Man!

kaithem-scripts provides some helpful utilities to set up the system.

Scripts starting with . need root.

# Currently, most distros don't have pipewire JACK enabled by default, which
# is needed for the audio mixing features.
kaithem-scripts root-use-pipewire-jack
kaithem-scripts user-restart-pipewire


# This activates a maxvolume service, which sets volume to full at boot.
kaithem-scripts user-max-volume-at-boot

# Linux by default has a LOT of stuff that writes
# excessively to the SD card. On a raspberry pi this
# Should make the system much more reliable without
# making anything work differently, except for putting logs in RAM
kaithem-scripts root-install-sd-protection

# Sets up a collection of misc tweaks that are recommended for kaithem.
kaithem-scripts root-install-linux-tweaks

# Installs Mosquitto and sets it up to allow anonymous clients.
kaithem-scripts root-enable-anon-mqtt

# Installs Mosquitto and sets it up to allow anonymous clients.
kaithem-scripts root-uninstall-bloatware

# Set up the Pi to display the Kaithem homepage(Can configure redirect in settings)
# On boot in a fullscreen kiosk
kaithem-scripts root-install-kiosk

Manual dev install

Info for devs here on the wiki (https://github.com/EternityForest/KaithemAutomation/wiki/Development)

Recent Changes 🕗

Good men, the last wave by, crying how bright
Their frail deeds might have danced in a green bay,
Rage, rage against the dying of the light.

(See Full Changelog)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

kaithem-0.86.0-py3-none-any.whl (7.4 MB view details)

Uploaded Python 3

File details

Details for the file kaithem-0.86.0-py3-none-any.whl.

File metadata

  • Download URL: kaithem-0.86.0-py3-none-any.whl
  • Upload date:
  • Size: 7.4 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.3

File hashes

Hashes for kaithem-0.86.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a6d58cdd883780082f9249dcf90135bbf510c1c7dcd02c20aeb5ad0f3ff4c46f
MD5 b28cd3e1620a46a8341ee070a3867c13
BLAKE2b-256 b266bc48437a8d17112f236482ba35dba3574ef10b23f5a50a6f0023e967afa7

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page