commit - da0734bf9fd577406b72b99990ad56c3c0aff43b
commit + 34d398546c3bf3df39aa8f0323799adf56f13003
blob - 9b479d32b5a5b3965a948ec69e6bb40b2d77e9b9
blob + 418656b87bdd36387603c2350460f6a57ab5f73a
--- thingsd/thingsd.8
+++ thingsd/thingsd.8
proxy daemon provides a mechanism for clients and client processes to
communicate with an array of serial and IoT things. At its core,
.Nm
-is primarily a packet repeater in that it polls for packets to swap between
+is primarily a packet repeater in that it waits for packets to swap between
subscriber clients and things. However,
.Nm
also provides password control over those connections, including client limits.
to send DEBUG priority messages to syslog.
.El
.Pp
-Example things tested: XBee, NF24, ESP8266.
+Example things tested: XBee, NF24, ESP8266, ESP32.
.Pp
Subscribers to a thing pass a simple, human-readable packet to
.Nm .
~~~subscribe{
{name,"CLIENTNAME"},
{things{
- thing{"dev1","password1"},
- thing{"dev2","password2"}
+ thing{"dev1","pass"},
+ thing{"dev2","pass"}
}
}
}
.Ed
.Pp
-An accurate example packet:
+An accurate example packet without linebreaks:
.Bd -literal -offset indent
-~~~subscribe{{name,"CLIENTNAME"},{things{thing{"dev1","password1"}}}}
+~~~subscribe{{name,"CLIENTNAME"},{things{thing{"dev1","pass"}}}}
.Ed
.Pp
.Nm
.Xr thingsctl 8 ,
.Xr rc 8 ,
.Xr rc.conf 8
-.Sh STANDARDS
-.Rs
-.Re
.Sh HISTORY
The busybeed program first began development on
.Ox 5.9 . The
.Nm
program refactoring and rename began on
.Ox 6.4 . thingsd name by Matthew Graybosch .
-
+.Sh AUTHORS
+.An -nosplit
+The
+.Xr thingsd 8
+program was written by
+.An Tracey Emery Aq Mt tracey@traceyemery.net .
blob - bdcc8630201ad061c841889e445d2a490560cb45
blob + 4c295ba3bd2f90a6ff046f1de26310c9179da69d
--- thingsd/thingsd.conf.5
+++ thingsd/thingsd.conf.5
.Os
.Sh NAME
.Nm thingsd.conf
-.Nd thingsd daemon configuration file
+.Nd thingsd proxy daemon configuration file
.Sh DESCRIPTION
.Nm
is the configuration file for the things proxy daemon,
.It Ic log verbose Ar number
Turn on verbose logging. (This option is currently disabled.)
.El
-.Sh thingS
+.Sh THINGS
things represent a serial thing or a TCP/IP host for
.Xr thingsd 8
to communicate with.
-.Xr thingsd 8
+.Xr thingsd 8
will setup sockets and bind to things depending on the settings for each
thing.
.Bl -tag -width Ds
.It Ic hardware Ar number
Set to 1 to turn on hardware control for a serial thing
.Ar location .
-OpenBSD doesn't use this. It's commented out in
-.Xr thingsd 8 .
.It Ic ipaddr Ar string Brq ...
Create a
.Ar thing
-connection to an IPV4 hostname or IP address. IPV6 is not implemented yet.
+connection to a hostname or IP address.
.It Ic listen on port Ar number
Set a local socket port for a
-.Ar location ,
-.Ar udp ,
+.Ar location ,
+.Ar udp ,
or
.Ar ipaddr
thing, other than the global default port.
Create a
.Ar thing
connection to serial interface. These are any valid /dev things, for example
-/dev/ttyU0.
+/dev/ttyU0. Set the owner of a thing to _thingsd to allow for autoreconnect in
+a privdrop environment, in the event of a serial thing disconnect.
.It Ic max clients Ar number
Set the maximum clients allowed to connect to a thing
.Ar location
Create a
.Ar thing
which listens for user datagram protocol packets.
-
.El
-.Sh FILES
-.Bl -tag -width Ds -compact
-.It Pa /etc/thingsd.conf
-.Xr thingsd 8
-configuration file.
-.El
.Sh EXAMPLES
This configuration file would create a serial thing and a TCP/IP host thing.
The serial thing would communicate on the default port, while the local network
}
.Ed
.Pp
+.El
+.Sh FILES
+.Bl -tag -width Ds -compact
+.It Pa /etc/thingsd.conf
+.Xr thingsd 8 configuration file.
.Sh SEE ALSO
.Xr thingsctl 8 ,
.Xr thingsd 8
.Sh HISTORY
The
.Nm
-file format first appeared with busybeed developed on
+file format first appeared with busybeed development on
.Ox 5.9 .
.Sh AUTHORS
.An -nosplit
The
.Xr thingsd 8
program was written by
-.An Tracey Emery Aq Mt tracey@traceyemery.com ,
-with extensive reading and perusing of
-.Xr ntpd 8
-and
-.Xr relayd 8 .
-Thank you to the real programmers who came before me.
-.Sh CAVEATS
-.Xr thingsd 8
-None yet.
+.An Tracey Emery Aq Mt tracey@traceyemery.net .