Add basic documentation for projector and keyboard.

This commit is contained in:
Florian Nücke
2022-02-09 01:44:31 +01:00
parent 024ee5881b
commit 2495d98aef
6 changed files with 32 additions and 6 deletions

View File

@@ -8,6 +8,8 @@ To quickly access the manual entry for a block in the world, simply use this [ma
- [Charger](charger.md)
- [Computer](computer.md)
- [Disk Drive](disk_drive.md)
- [Keyboard](keyboard.md)
- [Network Connector](network_connector.md)
- [Network Hub](network_hub.md)
- [Projector](projector.md)
- [Redstone Interface](redstone_interface.md)

View File

@@ -0,0 +1,12 @@
# Keyboard
![To click or not to click](block:oc2:keyboard)
The keyboard allows key presses to be picked up by [computers](computer.md). Its primary use-case is in combination with a [projector](projector.md), when using a Linux system.
When using the default Linux distribution, this device will provide events via the `evdev` system. To use its input this without additional configuration, use a [projector](projector.md). The keyboard input will be sent to the terminal session displayed there.
Note that the only face of the keyboard device large enough to fit a bus interface is at the bottom. Keyboards may be placed anywhere, as long as they're connected to the computer via a bus.
To start typing on a keyboard, simply interact with it. Experienced typists will find they do not need to look at the keys while typing (you can still look around while using the keyboard). Interact again to stop using the keyboard.
Computers *have to be shut down* before installing or removing this component. Installing it while the computer is running will have no effect, removing it may lead to system errors.

View File

@@ -0,0 +1,12 @@
# Projector
![Shadow on the wall](block:oc2:projector)
The projector provides a framebuffer device to [computers](computer.md). They have a resolution of 640 by 480 pixels, with the color format r5g6b5: 5 bits for the red color component, 6 bits for the green color component and 5 bits for the blue color component.
Projectors need to be powered directly to function. The device bus cannot provide enough energy on its own. When insufficiently powered, this is indicated by a red glow in the projector's lens.
On a Linux system, projectors will typically appear as `/dev/fbX` devices. To send data to the framebuffer, it is possible to write to these devices. For example, to clear a framebuffer one might pipe zeros to the device like so: `cat /dev/zero > /dev/fb0`.
When using the default Linux distribution, the [keyboard](keyboard.md) may be used, to send input to the virtual terminal, running on the first connected framebuffer.
Computers *have to be shut down* before installing or removing this component. Installing it while the computer is running will have no effect, removing it may lead to system errors.

View File

@@ -3,10 +3,10 @@
The network interface card (NIC) allows [computers](../block/computer.md) to send messages to and receive messages from [network connectors](../block/network_connector.md) attached to the computer.
Computers *have to be shut down* before installing or removing this component. Installing it while the computer is running will have no effect, removing it may lead to system errors.
These cards can be configured to only connect to selected sides (use while holding). This allows using multiple cards to build a custom router, for example.
When using the default Linux distribution, this device will provide a regular ethernet device. Network setup can either be performed manually, or using the convenience script `setup-network.lua`. This script provides the option to either use a fixed-address setup, or a DHCP setup. For a DHCP setup, exactly one computer in the network must act as a DHCP server.
After initial setup, use the command `ifconfig` to see the currently used IP address.
Computers *have to be shut down* before installing or removing this component. Installing it while the computer is running will have no effect, removing it may lead to system errors.

View File

@@ -3,10 +3,10 @@
The network tunnel card allows [computers](../block/computer.md) to send messages to and receive messages from another tunnel device (tunnel cards and [tunnel modules](network_tunnel_module.md)) linked to the card.
Computers *have to be shut down* before installing or removing this component. Installing it while the computer is running will have no effect, removing it may lead to system errors.
To link two tunnel devices, open their configuration interface (use while holding), and insert the other tunnel device to link to. This allows linking any two network tunnel devices.
When using the default Linux distribution, this device will provide a regular ethernet device. Network setup can either be performed manually, or using the convenience script `setup-network.lua`. This script provides the option to either use a fixed-address setup, or a DHCP setup. For a DHCP setup, exactly one computer in the network must act as a DHCP server.
After initial setup, use the command `ifconfig` to see the currently used IP address.
Computers *have to be shut down* before installing or removing this component. Installing it while the computer is running will have no effect, removing it may lead to system errors.

View File

@@ -3,10 +3,10 @@
The network tunnel module allows [robots](robot.md) to send messages to and receive messages from another tunnel device (tunnel modules and [tunnel cards](network_tunnel_card.md)) linked to the module.
Robots *have to be shut down* before installing or removing this component. Installing it while the robot is running will have no effect, removing it may lead to system errors.
To link two tunnel devices, open their configuration interface (use while holding), and insert the other tunnel device to link to. This allows linking any two network tunnel devices.
When using the default Linux distribution, this device will provide a regular ethernet device. Network setup can either be performed manually, or using the convenience script `setup-network.lua`. This script provides the option to either use a fixed-address setup, or a DHCP setup. For a DHCP setup, exactly one computer in the network must act as a DHCP server.
After initial setup, use the command `ifconfig` to see the currently used IP address.
Robots *have to be shut down* before installing or removing this component. Installing it while the robot is running will have no effect, removing it may lead to system errors.