storageManager

A script to push and pull items from storage. This is based on storage drawers and for now will only support one drawer controller connected to multiple storage drawers.

Setup

• [1] Computer
• [1.5] A Wireless Modem has to be connected to the Computer
• [2] Wired Modem (Right-click to make sure everything is connected!)
• [3] Transfer Chest (In- and Output)
• [4] Drawer Controller
• [5] Drawers

Note: You may leave space between Computer, Chest and Drawer Controller but you will need an modem next to each of those and have those modems connected via cables. You may also omit the modems entirely and have the Computer in between the Chest and the Drawer Controller. I would recommend to place the modem, since that will add the names of the connected peripherals to the output when using the peripherals command.

API

Note: Currently errors are not handled properly and the success field in the response may not always be accurate.

Send requests with rednet:

local host = <string> -- default: storageManager
local protocol = <string> -- default: storageManager#00
local message = <string> -- see below
rednet.send(host, message, protocol)

Get the response like this:

local protocol = <string> -- default: storageManager#00
local timeout = <number> -- will timeout after n-seconds
local id, message = rednet.receive(protocol, timeout)

Note: You will have to connect to a modem first.

Below you can find the available commands and an example for their requests and responses.

Peripherals

Request example:

local message = {
    ["command"] = "peripherals",
}

Response example:

local message = {
    ["success"] = true, -- returns if the call was successful or not
    ["peripherals"] = {
        peripheral <string>,
        -- ...
    }
}

List

Request example:

local message = {
    ["command"] = "list",
    ["peripheral"] = <string> -- peripheral name (e.g.: `minecraft:chest_2`)
}

Response example:

local message = {
    ["success"] = true, -- returns if the call was successful or not
    ["items"] = {
        [itemName <string>] = {
            -- note: slot is a number but returns as string so it does not mess with the table
            [slot <string>] = itemCount <number>
        },
        -- ...
    }
}

Put

Request example:

local message = {
    ["command"] = "put",
    ["from"] = <string>, -- peripheral name (e.g.: `minecraft:chest_2`)
    ["to"] = <string>, -- peripheral name (e.g.: `minecraft:chest_2`)
    ["fromSlot"] = <number>,
    ["count"] = <number>, -- defaults to 1
    ["toSlot"] = <number>, -- toSlot, will use any slot if not specified
}

Response example:

local message = {
    ["success"] = true -- returns if the call was successful or not
}

Extract

Request example:

local message = {
    ["command"] = "extract",
    ["from"] = <string>, -- peripheral name (e.g.: `minecraft:chest_2`)
    ["to"] = <string>, -- peripheral name (e.g.: `minecraft:chest_2`)
    ["fromSlot"] = <number>,
    ["count"] = <number>, -- defaults to 1
    ["toSlot"] = <number>, -- toSlot, will use any slot if not specified
}

Response example:

local message = {
    ["success"] = true -- returns if the call was successful or not
}

Pack

Used to pack multiple commands together in one request.

Request example:

local message = {
    ["command"] = "pack",
    ["pack"] = {
        -- id (will be used in the response) and the request you want to pack
        [id <string>] = request <table>,
        -- ...
    }
}

Response example:

local message = {
    ["success"] = true, -- returns if the call was successful or not
    ["pack"] = {
        {
            ["id"] = <string>,
            ["command"] = <string>,
            ["response"] = response <table>
        },
        -- ...
    }
}

Example

For a simple example, take a look at example/exampleAPIcall.lua.