Computer API

This API mainly provides information about the computer a Lua state is running on, such as its address and uptime. It also contains functions for user management. This could belong to the os table, but in order to keep that “clean” it's in its own API.

  • computer.address(): string
    The component address of this computer.
  • computer.tmpAddress(): string
    The component address of the computer's temporary file system (if any), used for mounting it on startup.
  • computer.freeMemory(): number
    The amount of memory currently unused, in bytes. If this gets close to zero your computer will probably soon crash with an out of memory error. Note that for OpenOS, it is highly recommended to at least have 1x tier 1.5 RAM stick or more. The os will boot on a single tier 1 ram stick, but quickly and easily run out of memory.
  • computer.totalMemory(): number
    The total amount of memory installed in this computer, in bytes.
  • computer.energy(): number
    The amount of energy currently available in the network the computer is in. For a robot this is the robot's own energy / fuel level.
  • computer.maxEnergy(): number
    The maximum amount of energy that can be stored in the network the computer is in. For a robot this is the size of the robot's internal buffer (what you see in the robot's GUI).
  • computer.uptime(): number
    The time in real world seconds this computer has been running, measured based on the world time that passed since it was started - meaning this will not increase while the game is paused, for example.
  • computer.shutdown([reboot: boolean])
    Shuts down the computer. Optionally reboots the computer, if reboot is true, i.e. shuts down, then starts it again automatically. This function never returns. This example will reboot the computer if it has been running for at least 300 seconds(5 minutes)
snippet.lua
local computer = require("computer")
if computer.uptime() >= 300 then
    computer.shutdown(true)
end
  • computer.getBootAddress():string
    Get the address of the filesystem component from which to try to boot first. New since OC 1.3.
  • computer.setBootAddress([address:string])
    Set the address of the filesystem component from which to try to boot first. Call with nil / no arguments to clear. New since OC 1.3.
  • computer.runlevel(): string|number

    Returns the current runlevel the computer is in. Current Runlevels in OpenOS are:

    • S: Single-User mode, no components or filesystems initialized yet
    • 1: Single-User mode, filesystems and components initialized - OpenOS finished booting
  • computer.users(): string, ...
    A list of all users registered on this computer, as a tuple. To iterate the result as a list, use table.pack on it, first. Please see the user rights documentation.
  • computer.addUser(name: string): boolean or nil, string
    Registers a new user with this computer. Returns true if the user was successfully added. Returns nil and an error message otherwise.
    The user must be currently in the game. The user will gain full access rights on the computer. In the shell, useradd USER is a command line option to invoke this method.
  • computer.removeUser(name: string): boolean
    Unregisters a user from this computer. Returns true if the user was removed, false if they weren't registered in the first place.
    The user will lose all access to this computer. When the last user is removed from the user list, the computer becomes accessible to all players. userdel USER is a command line option to invoke this method.
  • computer.pushSignal(name: string[, ...])
    Pushes a new signal into the queue. Signals are processed in a FIFO order. The signal has to at least have a name. Arguments to pass along with it are optional. Note that the types supported as signal parameters are limited to the basic types nil, boolean, number and string, tables and functions are not supported.
  • computer.pullSignal([timeout: number]): name, ...
    Tries to pull a signal from the queue, waiting up to the specified amount of time before failing and returning nil. If no timeout is specified waits forever.
    The first returned result is the signal name, following results correspond to what was pushed in pushSignal, for example. These vary based on the even type.
    important Please use event.pull instead. It returns the same data, provides a more advanced API, and does not interfere with proper driver operation. Do not call this method unless

Contents