Skip to main content

DeltaChat bridge for HiveMind — relay utterances between DeltaChat and the HiveMind bus

Project description

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 is delivered 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
--email-password Bot mailbox password
--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 that an OVOS pipeline produces spoken answers.
  • Mailbox login fails — verify IMAP/SMTP is enabled for the bot mailbox and 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.

Project details


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.0a1.tar.gz (16.3 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.0a1-py3-none-any.whl (12.6 kB view details)

Uploaded Python 3

File details

Details for the file hivemind_deltachat_bridge-0.1.0a1.tar.gz.

File metadata

File hashes

Hashes for hivemind_deltachat_bridge-0.1.0a1.tar.gz
Algorithm Hash digest
SHA256 c8d9f2490746ea12f3014ac3be4323e76a8a5046e9657ab99b761f4d5d8ca41e
MD5 b5ff5a6680fb9e17eb773833ca18ccef
BLAKE2b-256 7f9dc1309c78e825b064d36ce2481df2b391f348d6ac1c4a0641c839c27cc683

See more details on using hashes here.

File details

Details for the file hivemind_deltachat_bridge-0.1.0a1-py3-none-any.whl.

File metadata

File hashes

Hashes for hivemind_deltachat_bridge-0.1.0a1-py3-none-any.whl
Algorithm Hash digest
SHA256 f1376928c9f842e24d30d6c349b3cb3f9e706fdea52e6749ca7aad971cba155b
MD5 06596b10c39d6b702f4a32ac05c05683
BLAKE2b-256 ca5589c6ac01f3d31b77a02a546e2d4183366f36306897c4fb472dce0750af51

See more details on using hashes here.

Supported by

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