jkunz
2d42f72a81
SsdpDiscovery runs in the Rust device service, like mDNS. Its injection hooks give way to options: an interface allowlist and a search address. Behaviour stays as before; locations must name a dotted IPv4 host. The exports map no longer exposes ./dist_ts/*. The device service speaks protocol version 9.
devicemanager
The repository of @ecobridge.xyz/devicemanager, a TypeScript device manager for discovering and talking to scanners, printers, media players, smart-home and other network devices, and of the Rust device service it runs. The package documentation, with installation, usage and the API reference, is ts/readme.md, which is also the readme of the npm package.
Issue Reporting and Security
For reporting bugs, issues, or security vulnerabilities, please visit community.foss.global/. This is the central community hub for all issue reporting. Developers who sign and comply with our contribution agreement and go through identification can also get a code.foss.global/ account to submit Pull Requests directly.
Packages
Every release publishes five npm packages with one version. The repository's own package.json is private and is not published.
| Package | Source | Contents |
|---|---|---|
@ecobridge.xyz/devicemanager |
ts/ |
The TypeScript API (dist_ts/) and its sources; lists the four platform packages as optional dependencies |
@ecobridge.xyz/devicemanager-linux-x64 |
ts_native_linux_x64/ |
The device service for linux x64, static musl build |
@ecobridge.xyz/devicemanager-linux-arm64 |
ts_native_linux_arm64/ |
The device service for linux arm64, static musl build |
@ecobridge.xyz/devicemanager-darwin-x64 |
ts_native_darwin_x64/ |
The device service for darwin x64 |
@ecobridge.xyz/devicemanager-darwin-arm64 |
ts_native_darwin_arm64/ |
The device service for darwin arm64 |
Each package is described by the tspublish.json in its folder. A platform package carries exactly its binary and the binary's third-party notices.
Layout
ts/: the TypeScript package;ts/native/is the internal bridge to the device service.rust/: the Cargo workspace of the device service (ecobridge-device-service) and its protocol and core crates.ts_native_<os>_<cpu>/: the platform packages.scripts/place-native-binaries.mjs: copies each binary fromdist_rust/, with its notices, into the compiled folder of its platform package.native-notices/: the committed licence notices of the service binary, which@git.zone/rsrepogenerates and verifies; each platform package carries the notices of its binary.test/: the test suite.
Building and Testing
pnpm install --frozen-lockfile
pnpm build # TypeScript, the service for this host, and its platform package
pnpm test # Rust tests, then the TypeScript suite
pnpm exec rsrepo check # Rust format, lints, tests and docs
The release build, pnpm run build:release, builds all four binaries with rsrepo matrix build: the Linux targets on this machine and the darwin targets on a macOS builder over SSH. It reads the builder from DEVICEMANAGER_RELEASE_MACOS_SSH (an OpenSSH alias or user@host) and DEVICEMANAGER_RELEASE_MACOS_TEMP_ROOT (a dedicated absolute directory on the builder), which are set outside the repository. gitzone release runs it as its build step.
License and Legal Information
This repository contains open-source code licensed under the MIT License. A copy of the license can be found in the license.md file.
Please note: The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.
Trademarks
This project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH or third parties, and are not included within the scope of the MIT license granted herein.
Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines or the guidelines of the respective third-party owners, and any usage must be approved in writing. Third-party trademarks used herein are the property of their respective owners and used only in a descriptive manner, e.g. for an implementation of an API or similar.
Company Information
Task Venture Capital GmbH
Registered at District Court Bremen HRB 35230 HB, Germany
For any legal inquiries or further information, please contact us via email at hello@task.vc.
By using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.