This repository has been archived by the owner. It is now read-only.
Old. Please use thingsd instead.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
src
LICENSE.md
Makefile
README.md

README.md

busybeed for OpenBSD -- NOW known as thingsd!

This repos is now archived and will receive no more updates. Please use thingsd instead.

The busybeed OpenBSD daemon provides a mechanism for clients and client processes to communicate with an array of serial and IoT devices. At its core, busybeed is primarily a packet repeater in that it polls for packets to swap between subscriber clients and devices. However, busybeed also provides password control over those connections, including client limits.

Prerequisites

  • OpenBSD 6.3 or higher

Files

  • /usr/local/sbin/busybeed
  • /etc/examples/busybeed.conf
  • /etc/rc.d/busybeed

Usage

This is currently not in the ports tree. So, to test now on amd64 or i386 starting with OpenBSD 6.3 or snapshots:

	cd /etc/signify
	doas wget https://packages.traceyemery.net/emery-pkg.pub
	doas env PKG_PATH=https://packages.traceyemery.net/%m/ pkg_add busybeed

	Note: as the snapshots package could be in a state of flux,
	you might find it isn't always successful.

Edit busybeed.conf according to man busybeed.conf. Your settings will depend on your machine and the devices you have setup.

Once the busybeed.conf is edited, run rcctl enable busybeed and rcctl start busybeed. The busybeed daemon can also be run manually from the command line. To keep busybeed from daemonizing, run busybeed -d from the command line.

To test your setup, connect to your machine running busybeed with netcat:

	nc SERVERNAME PORT

Then paste in a subscription packet for your setup:

	~~~subscribe{{name,"CLIENT"},{devices{device{"dev","passwd"}}}}

You should start receiving packets from your setup device.

Further examples can be found in the src/examples directory above.

Todo

  • Finish busybctl functions
  • Implement TLS, maybe

Author

Tracey Emery

See the License file for more information.