ComputerCraft Wiki - User contributions [en]

Pocket Computer

2014-03-29T17:29:23Z

J15t98J: Added info about using the modem.

{{Block
|name=Pocket Computer
|image=Pocket_Computer_Large.png
|id=31709
|damage-value=The ID of the Computer.
|is-peripheral=No
}}
Pocket Computers, added in 1.6, are computers than are held as an inventory item, allowing you to use them on the move. To use a Pocket Computer, hold it in your hand and press the "use" key (this is a right-click by default). Both advanced and standard versions are available. It is also possible to craft Pocket Computers with wireless modems built in, which allows you to control your machines from anywhere or even [http://www.computercraft.info/forums2/index.php?/topic/17614-ultimate-door-lock-pda-opened-doors/ open doors] for you without having to do anything! The modem is attached to the back of the Pocket Computer, so to use it, wrap it with peripheral.wrap("back").

When removing from your inventory (dropping, moving in to chest, etc) the computer will stay on for 3-4 seconds. After that time it will turn it self off, you will not loose any data. The screen size of Pocket Computers is 26 wide by 20 high.

If the computer your program is running on is a Pocket Computer 'pocket' will be a blank table.
For example, to check if your program is running on Pocket Computer do:
if pocket then
print('Running on a Pocket Computer')
else
print('Running on a standard Computer')
end
[[Category:Items]]
[[Category:Consoles]]
== Recipes ==
Pocket Computer
{{Crafting grid
|A1=stone |B1=stone |C1=stone
|A2=stone |B2=Golden Apple |C2=stone
|A3=stone |B3=glass_pane |C3=stone
|Output=Pocket_Computer
}}

Advanced Pocket Computer
{{Crafting grid
|A1=Gold_Ingot |B1=Gold_Ingot |C1=Gold_Ingot
|A2=Gold_Ingot |B2=Golden_Apple |C2=Gold_Ingot
|A3=Gold_Ingot |B3=glass_pane |C3=Gold_Ingot
|Output=Advanced_Pocket_Computer
}}

Wireless Pocket Computer
{{Crafting grid
|B1=Modem
|B2=Pocket_Computer
|Output=Wireless_Pocket_Computer
}}

Advanced Wireless Pocket Computer
{{Crafting grid
|B1=Modem
|B2=Advanced_Pocket_Computer
|Output=Advanced_Wireless_Pocket_Computer
}}

== Usage ==
Hold the Pocket Computer in your hands then right click. To turn it off type 'shutdown' in to the shell.

Pocket Computers also come with a special program, falling, a Tetris game by by GopherAtl.

Below is a ingame screen of a Pocket Computer.

[[File:Pocket_Computer_Screenshot.png]]

{{BlocksItemsList}}

Printer

2013-03-24T12:44:15Z

J15t98J:

{{NeedsWork|Printer methods are not documented on this page.}}
{{Block
|name=Printer
|image=Iso_Printer.png
|id=4094
|damage-value=Un-used.
|is-peripheral=Yes
|peripheral-api=Printer (API)
}}
The printer was added in the [[ComputerCraft]] 1.42 update. The printer is placed next to a computer, and allows for printing text onto paper with any color of ink.

== Recipe ==
{{Crafting grid
|A1=stone |B1=stone |C1=stone
|A2=stone |B2=Redstone |C2=stone
|A3=stone |B3=Ink_Sac |C3=stone
|Output=printer
}}
== Usage ==
To use a printer, place it adjacently but not diagonally next to a computer (left, right, top, bottom, front, or back side). Place any color ink in the single left slot, and paper in any of the top slots.

If you are using blocks to pull/insert items from the printer the different slots are available from these sides:
Paper tray is accessible from the top, output paper tray is accessible from the front or bottom, and the ink slot is accessible from the back or sides.

[[File:PrinterGUI.png|thumb|256px|GUI of the Printer]]

[[Category:Blocks]][[Category:Peripherals]]

Peripheral (API)

2013-03-23T12:41:42Z

J15t98J: Remove needswork banner.

The Peripheral API is for interacting with external [http://en.wikipedia.org/wiki/Peripheral peripherals], such as the [[Disk Drive]], the [[Advanced Monitor]] and [[Monitor]].<br />
[[Computer|Computers]] and [[Turtle|Turtles]] are also considered peripherals and you can interface two adjacent computers, although in a more limited fashion compared to [[Rednet (API)|rednet]]. Both Computers and Turtles provide the same methods: ''turnOn'', ''shutdown'', ''reboot'', ''getID''.

<table style="width: 100%; border: solid 1px black; margin: 2px; border-spacing: 0px;">
<tr><td colspan="2" style="font-weight: bold; font-size: large; padding-bottom: .3em; border-bottom: solid #C9C9C9 1px; background: #D3FFC2; line-height:28px;">
[[File:Grid_disk.png|24px]]  
Peripheral (API)
</td></tr>

<tr><td style="width: 350px; background: #E0E0E0; padding: .4em; font-weight:bold;">Method Name</td><td style="background: #E0E0E0; padding: .4em; font-weight:bold;">Description</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[peripheral.isPresent]](side)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns '''true''' if a peripheral is present on ''side''.</td></tr>

<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[peripheral.getType]](side)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns the type or peripheral present on ''side'', nothing returned if ''side'' is empty.</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[peripheral.getMethods]](side)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns a table containing all methods for peripheral on ''side''.</td></tr>

<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[peripheral.call]](side, methodName, param1, param2, ...)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Sends a function call to peripheral located on ''side''. Return values match those of called method.<br />'''Note:''' ''methodName'' is a string.</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[peripheral.wrap]](side)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns a handle to the peripheral located on ''side''. If assigned to a variable, it can be used to call all methods available from that peripheral, as if calling '''peripheral.call()''', e.g.:<br />m = [[peripheral.wrap]]("left")<br />m.someMethod()<br />''- is the same as -''<br />[[peripheral.call]]("left","someMethod")</td></tr>

</table>

[[Category:APIs]]

==Remote Peripherals using Networking Cables==
Using Networking Cables, you can attach and use peripherals without having them directly touching the computer. To connect a peripheral in this way, place a Wired Modem on any side of your computer, as you would a [[Wireless Modem]], as well as all the peripherals you wish to connect, connecting all of them with Networking Cables. Then right click each of the wired modems. You should receive messages in your chat bar informing you of a successful connection. Don't forget to connect the [[Computer|computer]] too!

Finally, you need to wrap the wired modem on your [[Computer|computer]] using the methods above. As well as those outlined on the [[Modem_(API)| Modem API]] page, the following additional functions will then become available to you, where ''p'' is the variable the modem is wrapped to:

<table style="width: 100%; border: solid 1px black; margin: 2px; border-spacing: 0px;">
<tr><td style="width: 350px; background: #E0E0E0; padding: .4em; font-weight:bold;">Method Name</td><td style="background: #E0E0E0; padding: .4em; font-weight:bold;">Description</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">p.getNamesRemote()</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns the names of all connected peripherals. Peripheral names are the type of peripheral followed by an underscore and a unique number, e.g. ''"disk_0"''.</td></tr>

<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">p.isPresentRemote(peripheral name)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns '''true''' if the specified peripheral is connected; '''false''' otherwise. </td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">p.getTypeRemote(peripheral name)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns the type of the specified peripheral.</td></tr>

<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">p.getMethodsRemote(peripheral name)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns a table of all the methods for the specified peripheral. </td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">p.callRemote(peripheral name, peripheral method)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Calls the specified method for the specified peripheral.</td></tr>
</table>

==Monitor==
[[Monitor#Peripheral_Functions|Monitor Peripheral functions]] have been moved to the [[Monitor]] page.
In addition, the [[Advanced_Monitor#Peripheral_Functions|Advanced Monitor Peripheral functions]] have been moved to the [[Advanced Monitor]] page.

==Printer==
[[Printer#Peripheral_Functions|Printer Peripheral functions]] have been moved to the [[Printer]]page.

==Computers==
[[Computer#Peripheral_Functions|Computer Peripheral functions]] have been moved to the [[Computer]] page.
In addition, the [[Advanced_Computer#Peripheral_Functions|Advanced Computer Peripheral functions]] have been moved to the [[Advanced Computer]] page.

[[Category:APIs]]

Peripheral (API)

2013-03-23T12:41:11Z

J15t98J: Added tutorial for peripheral wrapping via networking cables.

{{NeedsWork|Remote peripheral wrapping via Cables isn't listed on this page.}}
The Peripheral API is for interacting with external [http://en.wikipedia.org/wiki/Peripheral peripherals], such as the [[Disk Drive]], the [[Advanced Monitor]] and [[Monitor]].<br />
[[Computer|Computers]] and [[Turtle|Turtles]] are also considered peripherals and you can interface two adjacent computers, although in a more limited fashion compared to [[Rednet (API)|rednet]]. Both Computers and Turtles provide the same methods: ''turnOn'', ''shutdown'', ''reboot'', ''getID''.

<table style="width: 100%; border: solid 1px black; margin: 2px; border-spacing: 0px;">
<tr><td colspan="2" style="font-weight: bold; font-size: large; padding-bottom: .3em; border-bottom: solid #C9C9C9 1px; background: #D3FFC2; line-height:28px;">
[[File:Grid_disk.png|24px]]  
Peripheral (API)
</td></tr>

<tr><td style="width: 350px; background: #E0E0E0; padding: .4em; font-weight:bold;">Method Name</td><td style="background: #E0E0E0; padding: .4em; font-weight:bold;">Description</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[peripheral.isPresent]](side)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns '''true''' if a peripheral is present on ''side''.</td></tr>

<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[peripheral.getType]](side)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns the type or peripheral present on ''side'', nothing returned if ''side'' is empty.</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[peripheral.getMethods]](side)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns a table containing all methods for peripheral on ''side''.</td></tr>

<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[peripheral.call]](side, methodName, param1, param2, ...)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Sends a function call to peripheral located on ''side''. Return values match those of called method.<br />'''Note:''' ''methodName'' is a string.</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[peripheral.wrap]](side)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns a handle to the peripheral located on ''side''. If assigned to a variable, it can be used to call all methods available from that peripheral, as if calling '''peripheral.call()''', e.g.:<br />m = [[peripheral.wrap]]("left")<br />m.someMethod()<br />''- is the same as -''<br />[[peripheral.call]]("left","someMethod")</td></tr>

</table>

[[Category:APIs]]

==Remote Peripherals using Networking Cables==
Using Networking Cables, you can attach and use peripherals without having them directly touching the computer. To connect a peripheral in this way, place a Wired Modem on any side of your computer, as you would a [[Wireless Modem]], as well as all the peripherals you wish to connect, connecting all of them with Networking Cables. Then right click each of the wired modems. You should receive messages in your chat bar informing you of a successful connection. Don't forget to connect the [[Computer|computer]] too!

Finally, you need to wrap the wired modem on your [[Computer|computer]] using the methods above. As well as those outlined on the [[Modem_(API)| Modem API]] page, the following additional functions will then become available to you, where ''p'' is the variable the modem is wrapped to:

<table style="width: 100%; border: solid 1px black; margin: 2px; border-spacing: 0px;">
<tr><td style="width: 350px; background: #E0E0E0; padding: .4em; font-weight:bold;">Method Name</td><td style="background: #E0E0E0; padding: .4em; font-weight:bold;">Description</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">p.getNamesRemote()</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns the names of all connected peripherals. Peripheral names are the type of peripheral followed by an underscore and a unique number, e.g. ''"disk_0"''.</td></tr>

<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">p.isPresentRemote(peripheral name)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns '''true''' if the specified peripheral is connected; '''false''' otherwise. </td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">p.getTypeRemote(peripheral name)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns the type of the specified peripheral.</td></tr>

<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">p.getMethodsRemote(peripheral name)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns a table of all the methods for the specified peripheral. </td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">p.callRemote(peripheral name, peripheral method)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Calls the specified method for the specified peripheral.</td></tr>
</table>

==Monitor==
[[Monitor#Peripheral_Functions|Monitor Peripheral functions]] have been moved to the [[Monitor]] page.
In addition, the [[Advanced_Monitor#Peripheral_Functions|Advanced Monitor Peripheral functions]] have been moved to the [[Advanced Monitor]] page.

==Printer==
[[Printer#Peripheral_Functions|Printer Peripheral functions]] have been moved to the [[Printer]]page.

==Computers==
[[Computer#Peripheral_Functions|Computer Peripheral functions]] have been moved to the [[Computer]] page.
In addition, the [[Advanced_Computer#Peripheral_Functions|Advanced Computer Peripheral functions]] have been moved to the [[Advanced Computer]] page.

[[Category:APIs]]

Modem (API)

2013-03-23T08:18:38Z

J15t98J: Added isWireless() method

With the advent of ComputerCraft 1.5, the behavior of modems has changed somewhat drastically. Although the rednet api still has the same functionality, it is really just a wrapper for what is a completely different system underneath.

The major change introduced to modems in this version of ComputerCraft is channels: Channels are essentially open networks which can be opened, closed, and listened on by any computer within range. To interact with channels, one must directly wrap the peripheral as opposed to the previous interaction with the rednet API.

Here is a list of functions available from modems:
{| border="1" cellpadding="2" cellspacing="0"
!style="background:#EEE" width="200px"|Function
!style="background:#EEE" width="*"|Description
|-
|isOpen( [[int_(type)|int]] channel )
|Check to see if the specified channel is open
|-
|open( [[int_(type)|int]] channel )
|Opens the specified channel to allow for listening. The channel specified must be larger than 0 and less than 65535.
|-
|close( [[int_(type)|int]] channel )
|Closes an open channel to disallow listening
|-
|closeAll( )
|Closes all open channels
|-
|transmit( [[int_(type)|int]] channel, [[int_(type)|int]] replyChannel, [[string_(type)|string]] message )
|Transmits a message on the specified channel
|-
|isWireless( )
|Returns true if the modem is wireless; false if it is wired.
|}
==Sending Messages==
Sending messages is simple and does not require that you open any channels. Simply use the transmit function like so:
<span>
local modem = peripheral.wrap("right") --Wraps the modem on the right side.
modem.transmit(3, 1, "Hello world!")
</span>

What did that do? First I wrapped the peripheral in order to interact with it. Second, I used modem.transmit(channel, replyChannel, message) in order to send my message. In case you were wondering, the reply channel is captured by the listening computer and suggests which channel they should reply on.

==Receiving Messages==
Receiving messages requires that you be familiar with events. As of this moment, there is no api which cuts out events from the process. Here is an example of how to receive messages:
<span>
local modem = peripheral.wrap("left")
modem.open(3)--Open channel 3 so that we can listen on it
local event, modemSide, senderChannel,
replyChannel, message, senderDistance = os.pullEvent("modem_message")
print("I just received a message from: "..senderChannel)
print("I should apparently reply on: "..replyChannel)
print("The modem receiving this is located on the "..modemSide.." side")
print("The message was: "..message)
print("The sender is: "..senderDistance.." blocks away from me.")
</span>
So what did I do? Quite simply, I called os.pullEvent() with the string argument "modem_message", which blocks all other events from being returned. When the "modem_message" event is captured, it returns the arguments: event, modemSide, senderChannel, replyChannel, message, senderDistance. I captured these and then printed them out.

==Keep in Mind...==
* You can only open 128 channels at any given time.
* The max channel you can open is 65535.
* You can listen on more than one channel at a time. For example, if I have channel 3 and channel 5 open and somebody sends a message on channel 5, I will still receive it. If they send a message on channel 3, I will receive that.
* Sending messages does not require you to open any channels prior to sending it.
* If you aren't receiving a message when you think you should, check to make sure that you have opened the channel first!
* Modems and channels are not secure! If you are sending a message over rednet, it is available to any computer listening on the sent channel.