izaya
/
OC-DSS2
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
Networked storage drawer based inventory system for OpenComputers. AKA AEn't v2
8 Commits 1 Branch 0 Tags 47 KiB
Lua 100%
Go to file
Izaya 7e4fd2f422 cleanup 2023-11-23 12:36:06 +10:00
OpenOS cleanup 2023-11-23 12:36:06 +10:00
LICENSE Initial commit 2021-09-03 10:50:09 +10:00
README.md clarification 2021-09-03 11:32:51 +10:00

README.md

OC-DSS2

Networked storage drawer based inventory system for OpenComputers. AKA AEn't v2

Design

OC-DSS2 uses a client-server model in that there is a server that is actually attached to the transposers that talk to the inventory system, and a number of clients that use the services remotely over the network.

Clients submit a search request (in the format described later) to the server, which responds with a liblz16-compressed stream of the search results. Clients can then use RPC endpoints on the server to request items be extracted to their location, if an alias has been set up for it.

Requirements

  • OpenOS
  • Minitel
  • Minitel RPC
  • liblz16
  • libsyslog (server only)
  • An 80x25 display (client only)

Setup

Note: It may be more practical to create an installer floppy rather than using oppm on every machine involved.

Server

  1. Install dss2-server and dependencies via oppm.
  2. Make sure the computer has a hostname set and the Minitel daemon is running and enabled.
  3. Add aliases with the addalias program - run it without arguments for usage information.
  4. Start the searchsrv daemon with rc searchsrv start
  5. Enable the searchsrv daemon with rc searchsrv enable

Client

  1. Install dss2-client and dependencies via oppm.
  2. Make sure the computer has a hostname setand the Minitel daemon is running and enabled.
  3. Put the name of the server into /etc/invsrv - either by editing the file, or something along the lines of echo <hostname> > /etc/invsrv
  4. Run search4 to bring up the interface.
  5. (Optional) Make search4 open on boot by adding it to /home/.shrc

Network protocol

In addition to standard RPC calls, OC-DSS2 uses a stream protocol on port 15 (by default).

Requests are submitted as a single line, in the form of key=value pairs, separated by tab characters. The keys map to itemstack values, such as name, label or maxSize.

The server responds with a liblz16-compressed stream, with one serialised table per line, each containing one resulting item stack.

RPC endpoints exported by OC-DSS2 are directly from the server-side "inv" library, contained in OpenOS/server/usr/lib/inv.lua.