Short:        Home Assistant client, MUI dashboard
Author:       jan@evil4dmin.zip (Jan Stermann)
Uploader:     jan evil4dmin zip (Jan Stermann)
Type:         comm/tcp
Version:      0.2
Replaces:     comm/tcp/ami2ha-0.1.1.lha
Requires:     bsdsocket.library; MUI 3.8+ for dashboard; AmiSSL 5 for https
Architecture: m68k-amigaos
Distribution: Aminet

ami2ha -- control your smart home from a real Amiga
===================================================

A native AmigaOS client for Home Assistant, the open-source home
automation server. Read your sensors, watch entity states and flip your
switches from a MUI dashboard, with an ARexx port so the rest of your
Workbench can join in.


WHAT IT DOES

  - sensors, gauges, toggles and buttons on a configurable MUI dashboard
  - pick which entities appear by giving them a label in Home Assistant,
    so you can change what the Amiga shows without touching the Amiga
  - a settings window for grouping, ordering, labelling and choosing how
    each entity is displayed
  - an ARexx port (AMI2HA): GET, ATTR, LIST, TOGGLE, ON, OFF, CALL,
    STATUS, so other programs can read the house and control it
  - reconnects by itself when the link drops, backing off up to a minute
  - talks https where AmiSSL 5 is installed, checking the certificate and
    the host name, so the access token can safely leave your own network --
    Home Assistant Cloud included
  - starts from Workbench, with its settings in the icon's tool types
  - command line modes that work without MUI: LIST, GET, ON, OFF, WATCH

Memory follows the size of your dashboard, not the size of your Home
Assistant. It asks the server only for the entities you show: measured
against an installation with 2079 entities, a dozen of them cost 1.3 KB
rather than 960 KB.


REQUIREMENTS

  - AmigaOS 3.0 or newer
  - a TCP/IP stack offering bsdsocket.library -- Roadshow, AmiTCP,
    Miami, or UAE's own emulation
  - MUI 3.8 or newer for the dashboard; the command line modes work
    without it
  - a 68020 is comfortable; a 68000 build is included and works, but
    JSON over TCP on a stock A500 is slow
  - a long-lived access token from your own Home Assistant


INSTALLING

Unpack and double-click Install, or from a Shell inside the drawer:

    Installer Install

Both a 68000 and a 68020 build are included; the installer picks the one
that matches. Full instructions are in ami2ha.guide -- open it with
MultiView.

You will need a long-lived access token: in Home Assistant, click your
user name at the bottom left, open the Security tab, and create one under
"Long-lived access tokens". It is shown once. Keep it in a file, and do
not pass it on a command line where your shell history would remember it.

By default the token travels over your network in the clear, which is fine
on your own LAN and not fine over the internet. Add the TLS switch and it
does not: see below.


HTTPS IS OPTIONAL

Plain HTTP on port 8123 remains the default and needs nothing extra --
no AmiSSL, no certificates, no configuration. Most people run ami2ha on
the same network as their server, and for them nothing has changed.

If you want it, adding the TLS switch connects over https instead. That
needs AmiSSL 5 installed, and it is only opened when TLS is actually
asked for, so it costs nothing on a plain setup. The certificate is
checked by default, both the chain and that it names the host you asked
for; a self-signed certificate needs NOVERIFY as well, which keeps the
traffic encrypted but stops proving who is answering.

It is worth it when you reach your house from somewhere else -- Home
Assistant Cloud works -- and mostly is not on a LAN, where it only costs
a slow machine time.


NOT YET

  - drag-and-drop reordering; Up and Down work today


LICENCE

MIT. Do what you like with it. Source, issues and newer versions:

    https://github.com/evil4dmin/ami2ha

Home Assistant is a separate project and nothing to do with the author:

    https://www.home-assistant.io/