Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

HiveMind DeltaChat Bridge

Relay a DeltaChat account to a HiveMind hub.

DeltaChat is an end-to-end-encrypted chat that runs over ordinary email. This bridge is a HiveMind satellite whose input and output are DeltaChat messages instead of a microphone. Each incoming chat message becomes an utterance sent to the hub. The hub's spoken reply goes back to the sender's chat. Any HiveMind hub, and the OVOS skills behind it, becomes reachable as an email-based chatbot.

DeltaChat (email)  ⇄  HiveMind-deltachat-bridge  ⇄  HiveMind hub (hivemind-core)  ⇄  OVOS skills

Prerequisites

  • A running HiveMind hub (hivemind-core) reachable over the network.
  • A HiveMind access key + password for this bridge, issued by the hub with hivemind-core add-client.
  • An email account for the bot (address + password). DeltaChat works with any IMAP/SMTP mailbox. The address is what users message to talk to the hub. The easiest option is a chatmail account (instant, bot-friendly): see docs/accounts-and-chatmail.md for how to get one and the full operator walkthrough.
  • The native libdeltachat / deltachat-core library installed on the system. The deltachat Python package binds to it.

Install

pip install HiveMind-deltachat-bridge

Or from a checkout:

git clone https://github.com/JarbasHiveMind/HiveMind-deltachat-bridge
cd HiveMind-deltachat-bridge
pip install .

This installs the hm-deltachat-bridge console command.

Quickstart

1. Register the bridge on the hub (run where hivemind-core is installed):

hivemind-core add-client --name deltachat-bridge \
  --access-key "your-access-key" --password "your-password"

2. Store the HiveMind credentials so they are read automatically:

hivemind-client set-identity \
  --key "your-access-key" \
  --password "your-password" \
  --host "ws://192.168.1.100"

(set-identity ships with hivemind-bus-client, a dependency of this bridge.) Alternatively, pass --key/--password/--host on every run.

3. Run the bridge with the bot's email login:

hm-deltachat-bridge \
  --email "bot@example.com" \
  --email-password "mailbox-password"

4. Send a message. From any DeltaChat app (or plain email), message bot@example.com:

what time is it?

The bridge forwards the message to the hub, waits for the speak reply, and answers in the same chat.

Configuration

hm-deltachat-bridge options:

Option Description Default
--email Bot mailbox address none
--email-password Bot mailbox password none
--key HiveMind access key read from identity file
--password HiveMind password read from identity file
--host HiveMind host (a ws:// prefix is added if no scheme) read from identity file
--port HiveMind port 5678

When --key/--password/--host are omitted they are read from the stored NodeIdentity. If none are available the bridge exits pointing you at hivemind-client set-identity.

Troubleshooting

  • NodeIdentity not set: run hivemind-client set-identity, or pass --key/--password/--host.
  • No reply to messages: confirm the hub is reachable and the access key is authorized (hivemind-core list-clients), and confirm an OVOS pipeline produces spoken answers.
  • Mailbox login fails: verify IMAP/SMTP is enabled for the bot mailbox, and that the password is an app password where the provider requires one.
  • ImportError on deltachat: install the native libdeltachat / deltachat-core for your platform.

Documentation

See docs/ for a full setup walkthrough, a credential reference, and worked examples.

Download files

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

Source Distribution

hivemind_deltachat_bridge-0.1.1a2.tar.gz (17.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

hivemind_deltachat_bridge-0.1.1a2-py3-none-any.whl (12.7 kB view details)

Uploaded Python 3

File details

Details for the file hivemind_deltachat_bridge-0.1.1a2.tar.gz.

File metadata

File hashes

Hashes for hivemind_deltachat_bridge-0.1.1a2.tar.gz
Algorithm Hash digest
SHA256 f92907faf3c288f82106d9e5f73a25576e438eed621872331e3d5029a8517c69
MD5 f26df716af6aba1f24c419e29ebb9445
BLAKE2b-256 d029d9035d9a72c75ab7dbad44795b2757e80a4e9c5d2fec6131caaad32480ce

See more details on using hashes here.

File details

Details for the file hivemind_deltachat_bridge-0.1.1a2-py3-none-any.whl.

File metadata

File hashes

Hashes for hivemind_deltachat_bridge-0.1.1a2-py3-none-any.whl
Algorithm Hash digest
SHA256 3d007ebb3f7bc3e15b4fedcd354a269fcb7bd728df29e7b21829b1ca6f75f202
MD5 dcd3fcff19f54d5e7a48a8d750e83706
BLAKE2b-256 c81a6d8578260d9e446c844c51588eb85e43ea4d426c4b53cef88d57e10c193f

See more details on using hashes here.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page