hivemind-core 0.1.0__tar.gz

hivemind-core-0.1.0/LICENSE

@@ -0,0 +1,211 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+
+=======================================================================
+
+Component licenses for mycroft-core:
+
+The mycroft-core software references various Python Packages (via PIP),
+each of which has a separate license.  All are compatible with the
+Apache 2.0 license. See the referenced packages listed in the
+"requirements/requirements.txt" file for specific terms and conditions.

hivemind-core-0.1.0/PKG-INFO

@@ -0,0 +1,10 @@
+Metadata-Version: 1.0
+Name: hivemind-core
+Version: 0.1.0
+Summary: Mesh Networking utilities for OpenVoiceOS
+Home-page: https://github.com/JarbasHiveMind/HiveMind-core
+Author: jarbasAI
+Author-email: jarbasai@mailfence.com
+License: Apache2.0
+Description: UNKNOWN
+Platform: UNKNOWN

hivemind-core-0.1.0/README.md

@@ -0,0 +1,322 @@
+# HiveMind Core
+
+HiveMind is an extension of [OpenVoiceOS (OVOS)](https://github.com/OpenVoiceOS/), the open-source voice assistant
+platform. It enables you to extend a single instance of `ovos-core` across multiple devices, even those with limited
+hardware capabilities that can't typically run OVOS.
+
+Demo videos in [youtube](https://www.youtube.com/channel/UCYoV5kxp2zrH6pnoqVZpKSA/)
+
+---
+
+## 🌟 Key Features
+
+- **Expand Your Ecosystem**: Seamlessly connect lightweight or legacy devices as satellites to a central OVOS hub.
+- **Centralized Control**: Manage and monitor all connected devices from a single hivemind-core instance.
+- **Fine-Grained Permissions**: Control skills, intents, and message access per client.
+- **Flexible Database Support**: Choose from JSON, SQLite, or Redis to fit your setup.
+
+---
+
+## 📖 Documentation & Community
+
+- 📚 **Documentation**: [HiveMind Docs (WIP)](https://jarbashivemind.github.io/HiveMind-community-docs)
+- 💬 **Chat**: Join the [HiveMind Matrix Chat](https://matrix.to/#/#jarbashivemind:matrix.org) for news, support, and
+  discussion.
+
+---
+
+## 🚀 Getting Started
+
+To get started, HiveMind Core provides a command-line interface (CLI) for managing clients, permissions, and
+connections.
+
+### Installation
+
+```bash
+pip install hivemind-core
+```
+
+### Adding a satellite
+
+Add credentials for each satellite device
+
+```bash
+$ hivemind-core add-client --db-backend sqlite 
+Database backend: SQLiteDB
+Credentials added to database!
+
+Node ID: 3
+Friendly Name: HiveMind-Node-2
+Access Key: 42caf3d2405075fb9e7a4e1ff44e4c4f
+Password: 5ae486f7f1c26bd4645bd052e4af3ea3
+Encryption Key: f46351c54f61a715
+WARNING: Encryption Key is deprecated, only use if your client does not support password
+```
+
+**NOTE**: you will need to provide this info on the client devices in order to connect
+
+### Running the Server
+
+Start the HiveMind Core server to accept connections:
+
+```bash
+$ hivemind-core listen --port 5678
+```
+
+---
+
+## 🛠️ Commands Overview
+
+HiveMind Core CLI supports the following commands:
+
+```bash
+$ hivemind-core --help
+Usage: hivemind-core [OPTIONS] COMMAND [ARGS]...
+
+Options:
+  --help  Show this message and exit.
+
+Commands:
+  add-client          Add credentials for a client.
+  allow-msg           Allow specific message types from a client.
+  blacklist-intent    Block certain intents for a client.
+  blacklist-skill     Block certain skills for a client.
+  delete-client       Remove client credentials.
+  list-clients        Display a list of registered clients.
+  listen              Start listening for HiveMind connections.
+  unblacklist-intent  Remove intents from a client's blacklist.
+  unblacklist-skill   Remove skills from a client's blacklist.
+```
+
+For detailed help on each command, use `--help` (e.g., `hivemind-core add-client --help`).
+
+---
+
+### `add-client`
+
+Add credentials for a new client that will connect to the HiveMind instance.
+
+```bash
+$ hivemind-core add-client --name "satellite_1" --access-key "mykey123" --password "mypass" --db-backend json
+```
+
+- **When to use**:  
+  Use this command when setting up a new HiveMind client device (e.g., a Raspberry Pi or another satellite). You’ll need
+  to provide the credentials for secure communication.
+
+---
+
+### `list-clients`
+
+List all the registered clients and their credentials.
+
+```bash
+$ hivemind-core list-clients --db-backend json
+```
+
+- **When to use**:  
+  Use this command to verify which clients are currently registered or to inspect their credentials. This is helpful for
+  debugging or managing connected devices.
+
+---
+
+### `delete-client`
+
+Remove a registered client from the HiveMind instance.
+
+```bash
+$ hivemind-core delete-client 1
+```
+
+- **When to use**:  
+  Use this command to revoke access for a specific client. For instance, if a device is lost, no longer in use, or
+  compromised, you can remove it to maintain security.
+
+---
+
+### `allow-msg`
+
+Allow specific message types to be sent by a client.
+
+```bash
+$ hivemind-core allow-msg "speak"
+```
+
+- **When to use**:  
+  This command is used to fine-tune the communication protocol by enabling specific message types. This is especially
+  useful in scenarios where certain clients should only perform limited actions (e.g., making another device speak via
+  TTS).
+
+---
+
+### `blacklist-skill`
+
+Prevent a specific skill from being triggered by a client.
+
+```bash
+$ hivemind-core blacklist-skill "skill-weather" 1
+```
+
+- **When to use**:  
+  Use this command to restrict a client from interacting with a particular skill. For example, a child’s device could be
+  restricted from accessing skills that are not age-appropriate.
+
+---
+
+### `unblacklist-skill`
+
+Remove a skill from a client’s blacklist.
+
+```bash
+$ hivemind-core unblacklist-skill "skill-weather" 1
+```
+
+- **When to use**:  
+  If restrictions are no longer needed, use this command to restore access to the blacklisted skill.
+
+---
+
+### `blacklist-intent`
+
+Block a specific intent from being triggered by a client.
+
+```bash
+$ hivemind-core blacklist-intent "intent.check_weather" 1
+```
+
+- **When to use**:  
+  Use this command when fine-grained control is needed to block individual intents for a specific client, especially in
+  environments with shared skills but different permission levels.
+
+---
+
+### `unblacklist-intent`
+
+Remove an intent from a client’s blacklist.
+
+```bash
+$ hivemind-core unblacklist-intent "intent.check_weather" 1
+```
+
+- **When to use**:  
+  This command allows you to reinstate access to previously blocked intents.
+
+---
+
+### `listen`
+
+Start the HiveMind instance to accept client connections.
+
+```bash
+$ hivemind-core listen --ovos_bus_address "127.0.0.1" --port 5678
+```
+
+- **When to use**:  
+  Run this command on the central HiveMind instance (e.g., a server or desktop) to start listening for connections from
+  satellite devices. Configure host, port, and security options as needed.
+
+---
+
+#### Running in Distributed Environments
+
+By default, HiveMind listens for the OpenVoiceOS bus on `127.0.0.1`. When running in distributed environments (e.g.,
+Kubernetes), use the `--ovos_bus_address` and `--ovos_bus_port` options to specify the bus address and port.
+
+---
+
+## 📦 Database Backends
+
+HiveMind-Core supports multiple database backends to store client credentials and settings. Each has its own use case:
+
+| Backend            | Use Case                                       | Default Location                            | Command Line options                               |
+|--------------------|------------------------------------------------|---------------------------------------------|----------------------------------------------------|
+| **JSON** (default) | Simple, file-based setup for local use         | `~/.local/share/hivemind-core/clients.json` | Configurable via `--db-name` and `--db-folder`     |
+| **SQLite**         | Lightweight relational DB for single instances | `~/.local/share/hivemind-core/clients.db`   | Configurable via `--db-name` and `--db-folder`     |
+| **Redis**          | Distributed, high-performance environments     | `localhost:6379`                            | Configurable via `--redis-host` and `--redis-port` |
+
+**How to Choose?**
+
+- For **scalability** or multi-instance setups, use Redis.
+- For **simplicity** or single-device environments, use JSON or SQLite.
+
+---
+
+## 🔒 Protocol Support
+
+| Feature              | Protocol v0 | Protocol v1 |
+|----------------------|-------------|-------------|
+| JSON serialization   | ✅           | ✅           |
+| Binary serialization | ❌           | ✅           |
+| Pre-shared AES key   | ✅           | ✅           |
+| Password handshake   | ❌           | ✅           |
+| PGP handshake        | ❌           | ✅           |
+| Zlib compression     | ❌           | ✅           |
+
+> **Note**: Some clients (e.g., HiveMind-JS) do not yet support Protocol v1.
+
+---
+
+## 🧩 HiveMind Ecosystem
+
+### Minds
+
+You must run at least one of these
+
+- **HiveMind Core** (this repository): The central hub for managing connections and routing messages between devices.
+  *text* input only
+- [Hivemind Listener](https://github.com/JarbasHiveMind/HiveMind-listener) - an extension of `hivemind-core` for
+  streaming *audio* from satellites **<- you likely want this one**
+- [Persona](https://github.com/JarbasHiveMind/HiveMind-persona) - run
+  a [persona](https://github.com/OpenVoiceOS/ovos-persona) (eg. LLM). *text* input only
+
+### Client Libraries
+
+- [HiveMind WebSocket Client](https://github.com/JarbasHiveMind/hivemind_websocket_client)
+- [HiveMind JS](https://github.com/JarbasHiveMind/HiveMind-js)
+
+### Terminals
+
+- [Voice Satellite](https://github.com/OpenJarbas/HiveMind-voice-sat)  (standalone OVOS *local* audio stack)
+- [Voice Relay](https://github.com/JarbasHiveMind/HiveMind-voice-relay)  (lightweight audio satellite, STT/TTS
+  processed *server* side, **requires** `hivemind-listener`)
+- [Mic Satellite](https://github.com/JarbasHiveMind/hivemind-mic-satellite) (only VAD runs on device, audio streamed
+  and fully processed *server* side, **requires** `hivemind-listener`)
+- [Web Chat](https://github.com/OpenJarbas/HiveMind-webchat) (*client-side* browser hivemind connection)
+- [Flask Chatroom](https://github.com/JarbasHiveMind/HiveMind-flask-template)  (**boilerplate template** - *server-side*
+  hivemind connection)
+
+### Bridges
+
+- [Mattermost Bridge](https://github.com/OpenJarbas/HiveMind_mattermost_bridge)
+- [DeltaChat Bridge](https://github.com/JarbasHiveMind/HiveMind-deltachat-bridge)
+
+---
+
+## Voice Satellite Comparison
+
+| Feature                            | **HiveMind Voice Satellite**               | **HiveMind Voice Relay**                                                                  | **HiveMind Microphone Satellite**                            |
+|------------------------------------|--------------------------------------------|-------------------------------------------------------------------------------------------|--------------------------------------------------------------|
+| **Use Case**                       | Full voice satellite with local processing | Offloads voice processing to **HiveMind Listener**, better suited for secure environments | Super lightweight satellite for fully remote audio streaming |
+| **Audio Processing**               | Local (STT, TTS, Wake Word, VAD)           | STT and TTS handled on **HiveMind Listener**                                              | Wake Word, STT and TTS handled on **HiveMind Listener**      |
+| **Server Requirements**            | Works with **all** mind implementations    | Requires **hivemind-listener**                                                            | Requires **hivemind-listener**                               |
+| **Voice Activity Detection (VAD)** | Handled locally                            | Handled locally                                                                           | Handled locally                                              |
+| **Wake Word Detection**            | Handled locally                            | Handled locally                                                                           | Handled by **HiveMind Listener**                             |
+| **STT Processing**                 | Handled locally                            | Handled by **HiveMind Listener**                                                          | Handled by **HiveMind Listener**                             |
+| **TTS Processing**                 | Handled locally                            | Handled by **HiveMind Listener**                                                          | Handled by **HiveMind Listener**                             |
+| **Media Playback Support**         | Yes, with supported plugins                | Yes, with supported plugins                                                               | No                                                           |
+| **PHAL plugins**                   | Supported                                  | Supported                                                                                 | Unsupported                                                  |
+| **Transformer plugins**            | Supported                                  | Supported                                                                                 | Unsupported                                                  |
+
+---
+
+## 🤝 Contributing
+
+Contributions are welcome!
+
+---
+
+## ⚖️ License
+
+HiveMind is open-source software, licensed under the [Apache 2.0 License](LICENSE).
+
+

hivemind-core-0.1.0/hivemind_core/__init__.py

@@ -0,0 +1,16 @@
+# Copyright 2017 Mycroft AI Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+from ovos_utils.log import init_service_logger
+
+init_service_logger("HiveMind")

hivemind-core-0.1.0/hivemind_core/__main__.py

@@ -0,0 +1,10 @@
+from hivemind_core.service import HiveMindService
+
+
+def main():
+    service = HiveMindService()
+    service.run()
+
+
+if __name__ == "__main__":
+    main()