Skip to content

Pinna 0.5.0

Latest

Choose a tag to compare

@github-actions github-actions released this 21 Nov 10:25
· 53 commits to main since this release

Satellites in standalone mode can form a group that passes messages and acts on each other. You can add your own wake words, play music from Music Assistant over Sendspin, and protect the dashboard with a password.

Before you update

  • The Wi-Fi driver changed. The setup hotspot needs a part of the MT8163
    Wi-Fi driver that 0.3.0 left out. The update's health check doesn't need
    Wi-Fi: if the satellite doesn't join your network after the update, it
    stays on the new version, and you reach it only over USB. Keep the cable at
    hand, and see Recovery.
  • The dashboard offers a password. The first time you open it after the
    update, it asks you to set one or to leave it open. Leaving it open changes
    nothing. Before you set one: Prometheus and agents that call /metrics or
    /mcp need tokens, which you can create first. If you later go back to
    0.3.0, that version doesn't ask for the password.
  • Pinna finds the hardware in a new way. The code that finds the ring,
    the buttons, the microphone switch and the sound card was rewritten to read
    one description of each Echo. Nothing should change, but this is tested in
    the virtual machine, not yet on an Echo. If the ring, a button or the sound
    stops working after the update, go back to 0.3.0, as
    Go back to an older version
    describes.

Highlights

Satellite groups

Satellites in standalone mode on the same subnet can form a satellite group.
Ask one to pass a message, such as "tell the kitchen that dinner is ready",
and the satellite in the kitchen says it in its own voice. A satellite that is
busy holds up to 5 messages and plays them once it is Idle. The brain can also
act on another member by its name: "turn the kitchen down", "set a 10 minute
timer in the office" or "stop the music in the hall". Set the group up on each
satellite's dashboard under Assistant > Satellite group, where Group
messages
and Control from the group turn either part off for that
satellite. If two satellites of a group hear the wake word, both still answer:
choosing one is planned. See
Satellite groups.

Add your own wake word

Open Voice & sound > Wake words to add up to eight wake words of your own:
a phrase and its openWakeWord model, an .onnx or .tflite file of at most
2 MiB. The satellite tests the model in a process of its own before it keeps
it, and if it refuses the model, the page says why. Pinna can't run
microWakeWord models, and says so when you add one. Choose the new word like
the built-in ones, on Voice & sound or in Home Assistant. See
Add your own wake word.

Play music with Sendspin

Turn on Sendspin under Voice & sound > Media sources, or with the
Sendspin switch in Home Assistant. Music Assistant 2.10.7 or later then
lists the satellite as a player and plays to it in step with the other
Sendspin speakers of a group. The wake word keeps working, and replies,
announcements and timer alarms play over the music. Sendspin is experimental
and off until you turn it on. It is tested against Music Assistant's server on
a computer, not yet on an Echo. See
Play music with Sendspin.

A password for the dashboard

To set one, open System > Password and tokens, select Set a password…,
and press Action on the satellite when the ring circles white. With a
password, the dashboard, the control API and the log need you to be signed in,
and the metrics and /mcp need
tokens.
It also closes the ESPHome API to a Home Assistant that has no key for the
satellite yet, and group joins, until you open them. The password travels
unencrypted, so use one that you use nowhere else. See
Who can use the dashboard.

New in Home Assistant

  • Group messages (switch): whether the satellite takes messages from the
    other satellites of its group, for example turned off by an automation at
    night.
  • Sendspin (switch): turns the Sendspin player on or off.
  • Install updates (select): Manually or Automatically.
  • Install window start and Install window end (time): when automatic
    installs may happen, in the satellite's time zone.
  • The Wake word and Wake word 2 selectors list the words you added.

Other changes

  • Updates can install by themselves in a window you choose, 03:00 to 05:00
    unless you change it: set Install updates to Automatically on
    System > Updates. The satellite restarts only when it is Idle, and
    Manually stays the default. See
    Install updates automatically.
  • A satellite with no saved Wi-Fi network opens a setup hotspot, Pinna
    setup
    followed by its hostname, with the password pinnasetup. Join it
    with your phone and choose your network. It is tested in the virtual
    machine, not yet on an Echo. See
    Connect to Wi-Fi.
  • In standalone mode, ask "is there an update?": the satellite says which
    version it runs and checks for a new one. It installs one only once you turn
    on Install update under Assistant > Tools. See
    Ask the satellite to update.
  • System > Record audio records up to 30 seconds of what the satellite
    hears, for a developer to see why the wake word or the echo cancellation
    misbehaves. It needs a dashboard password and a press of Action. See
    Record what the satellite hears.
  • Copy for an issue on System > Logs copies the version, the model, how
    the last start ended and the log, without addresses or Wi-Fi names. See
    Report a problem.
  • The log fills the window and follows the newest line while you are at the
    bottom.
  • System opens pages for Updates, Password and tokens and
    Logs, and the ring's settings have their own page under Voice &
    sound > Ring
    .
  • The dashboard shows Pinna's new mark.
  • The satellite reports its release version to Home Assistant, in its logs
    and in --version, instead of 0.1.0.
  • The log names the level, the automatic gain and the score of each wake word.

Fixed

  • Two changes close together, such as a new name and a new key from Home
    Assistant, no longer leave the older of them in the satellite's mDNS record.
  • Rescue mode and the dashboard link to the docs at getpinna.dev.

All changes

Changes since 0.3.0.

New

  • The ring settings have their own page under Voice & sound (dashboard)
  • The brain tells the version and update state and checks for updates (pinnad)
  • The brain installs an update once the owner turns the tool on (pinnad)
  • Binaries report the release version instead of 0.1.0
  • The capture loop logs each wake word's level before the gain (pinnad)
  • PeerService carries signed calls between satellites in a group (proto)
  • Group membership rules and signatures (ADR 0026) (pinnad)
  • The mDNS record can carry the satellite's group (pinna-esphome)
  • The search reads each satellite's group and counts its searches (pinnad)
  • The satellite group is saved in standalone.toml with its key in secrets.toml (pinnad)
  • The dashboard reads the satellite group and its candidates (pinnad)
  • The mDNS record carries the satellite's group from boot (pinnad)
  • A group's signature names the call it was made for (pinnad)
  • The dashboard adds and removes satellite group members through PeerService (pinnad)
  • Members exchange the group's list after each search and leave a group that ended (pinnad)
  • Group messages is a setting and a Home Assistant switch (pinnad)
  • A member says a message from another member, or holds it until it is free (pinnad)
  • The brain sends a message to a member or to all of them (pinnad)
  • The brain's context names the other members of the satellite group (pinnad)
  • A member runs a tool call from the group as its own /mcp would (pinnad)
  • The brain acts on another member's satellite by its name (pinnad)
  • The Assistant page sets up the satellite group (dashboard)
  • The Overview shows how many messages are held (dashboard)
  • Test an uploaded wake word model on silence, noise and time (pinna-wakeword)
  • The device can replace the wake words it offers (pinna-esphome)
  • Owners add and remove custom wake words, tested in a process of their own (pinnad)
  • Add and remove custom wake words (dashboard)
  • Build the MT8163 Wi-Fi access point (kernel)
  • A hotspot unit that runs hostapd on ap0 (image)
  • A satellite with no saved Wi-Fi network runs a setup hotspot (pinnad)
  • The Network page shows the setup hotspot (dashboard)
  • The API carries the Sendspin player's status and switch (pinnad)
  • The player completes the Noise handshake as responder with the key the server names (pinna-sendspin)
  • Binary frames and JSON messages are read within the specification's limits (pinna-sendspin)
  • The player follows the server's clock with the specification's time filter (pinna-sendspin)
  • The player keeps a pairing key and up to eight pairings (pinna-sendspin)
  • A sans-IO connection runs a player session from client/init to playback (pinna-sendspin)
  • Decode Sendspin audio chunks, PCM and FLAC (pinna-audio)
  • The speaker session anchors its frame times to the hardware pointer (pinna-audio)
  • The media lane plays a timed source at the time a server's clock sets (pinna-audio)
  • Media sources switches the Sendspin player on and shows its status (dashboard)
  • The Sendspin player keeps its keys, pairings and volume (pinnad)
  • The Sendspin player listens, plays on the server's timeline and reports (pinnad)
  • Home Assistant gets a Sendspin switch (pinna-esphome)
  • The Sendspin switch starts the player, follows renames and shows in Status (pinnad)
  • Pause, play, stop and the media volume act on the Sendspin group (pinnad)
  • /metrics shows the Sendspin player's state and how well it keeps time (pinnad)
  • pinnad.toml can move the Sendspin player to another port and its record to another file (pinnad)
  • Time entities, and the install updates select and window times (pinna-esphome)
  • Updates install by themselves inside the owner's window (pinnad)
  • Choose whether updates install by themselves, and the window (dashboard)
  • A confirm pattern on the ring (pinna-hal)
  • secrets.toml carries the dashboard's password table (pinna-assist)
  • The next Action press confirms a change at the satellite (pinnad)
  • DeviceService calls for the dashboard password (proto)
  • The dashboard asks for a password once one is set (pinnad)
  • The dashboard asks for its password, and sets, changes and removes it (dashboard)
  • The server can refuse connections while it has no key (pinna-esphome)
  • A password closes the ESPHome API, group joins and unprotected members until the owner acts (pinnad)
  • The pages show the windows a password closes, and the rollback warning (dashboard)
  • A waiting confirmation shows who asked and can be canceled (pinnad)
  • Password flows show a waiting confirmation, count waits down and explain themselves (dashboard)
  • Updates, and the password and tokens, get their own pages under System (dashboard)
  • The satellite group gets its own page under Assistant (dashboard)
  • The Updates row says when a developer's address replaces the channel (dashboard)
  • The Logs row on System looks like the rows beside it (dashboard)
  • The log fills the window and follows the newest line at the bottom (dashboard)
  • Copy for an issue puts the satellite's details and its log on the clipboard (dashboard)
  • The logo always shows the mark, and the live ring stays beside the name (dashboard)
  • RecordAudio, StopRecording, and a purpose for a confirmation (proto)
  • A WAV writer for recordings (dashboard)
  • The Overview names a recording, and lets another dashboard stop it (dashboard)
  • System > Record audio records what the satellite hears after a press of Action (dashboard)
  • A recording confirmation circles in the Listening colour (pinna-hal)
  • A confirmation has a purpose, and a recording grant belongs to its session (pinnad)
  • RecordAudio streams what the satellite hears for up to 30 seconds (pinnad)

Fixed

  • The docs links point to getpinna.dev
  • The mDNS record ends up as the latest of two changes close together (pinnad)
  • A streaming microWakeWord model is refused as one, not as a crash (pinna-wakeword)
  • Clock bursts start less than 10 s apart when the timer fires late (pinna-sendspin)
  • A new pairing never evicts the record of an open connection (pinna-sendspin)
  • Arbitration between idle servers uses the current last-playback server (pinna-sendspin)
  • A server whose clock drifts more than 1 % is closed (pinna-sendspin)
  • Audio counts against buffer_capacity until due on the player's clock (pinna-sendspin)
  • Close reasons quote the server escaped and at most 200 characters (pinna-sendspin)
  • A server that closes before server/init is reported as probably too old (pinna-sendspin)
  • A pause ends a waiting timed source while a stream or another timed source plays (pinna-audio)
  • A Sendspin chunk that decodes to more than a second is refused (pinna-audio)
  • A timed source jumps every error it cannot slew within 1 ms in 10 s (pinna-audio)
  • A format change in place keeps a timed source's speed from its first chunk (pinna-audio)
  • After an underrun the speaker identifies its restarted pointer in seconds (pinna-audio)
  • A stream with no source reads "From AirPlay or Bluetooth" again (dashboard)
  • Sendspin's failure reasons say couldn't, as pinnad's other errors do (pinnad)
  • Music Assistant's group/update with a UUID group_id no longer closes the connection (pinna-sendspin)
  • A format change in place no longer moves a timed source 1.4 frames off its timeline (pinna-audio)
  • A Sendspin server's volume commands keep one write to the flash in flight, at most one every 2 s (pinnad)
  • Stop and a queue that runs out leave a Sendspin satellite Idle, not Paused (pinnad)
  • The media player's volume is the speaker's while a Sendspin group waits paused (pinnad)
  • /metrics shows a playing Sendspin player as connected (pinnad)
  • A satellite leaves a paused Sendspin group once, not at every media update (pinnad)
  • Media sources tells an owner on another VLAN how to add the Sendspin player (dashboard)
  • A URL that fails to open no longer takes the satellite out of its paused Sendspin group (pinnad)
  • Stop shows a paused Sendspin group Idle even when the server takes no stop (pinnad)
  • A server that plays again is remembered as the last one, whatever its connection started with (pinna-sendspin)
  • Media sources and Now playing tell the truth about a Sendspin group (dashboard)
  • An install window refuses a minute past 23:59 (pinnad)
  • Without a session, GetSecurity says only what signing in needs (pinnad)
  • The list of satellites marks a member only at the address its signed call came from (pinnad)
  • A confirming Action press keeps its hold from Home Assistant (pinnad)
  • Switching to manually leaves the restart after an automatic install to the owner (pinnad)
  • The Home Assistant window shows in standalone mode too (dashboard)
  • A waiting confirmation doesn't tell the caller to press Action (pinnad)
  • The token refusals point to System > Password and tokens (pinnad)
  • System's rows read plainly, and its pages are listed in the hub's order (dashboard)
  • The token refusals write the dashboard path as the dashboard does (pinnad)
  • Credit LibreEcho in the ported drivers and patches (kernel)
  • The setup hotspot advertises the basic rates it requires (kernel)
  • The Logs page keeps the reader's line across filters, and a short window scrolls (dashboard)
  • Copy for an issue also scrubs BlueZ addresses and the default name (dashboard)
  • Copying on plain http keeps the keyboard on the button (dashboard)
  • Asking for the access state while a request runs waits for that request (dashboard)
  • Password and tokens says why it couldn't read the access state, instead of staying empty (dashboard)
  • A recording shows Listening above a timer's arc and a notification, as on the satellite (dashboard)

Files

Install: https://getpinna.dev/docs/flash/
Signed with keys/release.pub: 1170dfc308acae842fd81cbff011ecf33f2c0feb056fa2ec9998bc012fc9f706

333e874c24c7c3ce360801790a5995ecc74a7e1869a99e95182bc9b6585cea26  pinna-0.5.0.root.img
6959bb335a8b314c529fd19cd641f3455046dfe2a95bd3a9736a28699c2df3b6  pinna-boot.img
eb375a940bbde2220af9502c2a5722c33e2a46396ebb4a9b07640dc633850920  manifest.json
b76a5d1e8d1a4220bcc6d9dc75c71615b4d204ea662e2844b31e7ad823d0db36  manifest.json.sig
754bf31599889b139a23e2bd49872c1c9d14b4f4bde401be533d17fab652d4c3  flash-gen2.sh