Difference between revisions of "Peripheral (API)"

From ComputerCraft Wiki
Jump to: navigation, search
(Console -> Computer)
(Computers: Adding modems)
 
(20 intermediate revisions by 10 users not shown)
Line 1: Line 1:
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 />
+
{{msgbox
[[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''.
+
| text = This article is about the Peripheral API. For APIs exposed when wrapping peripherals through [[peripheral.wrap]]() see [[:Category:Peripheral_APIs|Peripheral APIs]].
 +
}}
  
==Methods==
+
__TOC__
{| class="wikitable"
+
The Peripheral API is for interacting with [[peripheral]]s connected to the computer, such as the [[Disk Drive]], the [[Advanced Monitor]] and [[Monitor]]. (More peripherals can be found under [[:Category:Peripherals|here]]).
!style="background:#EEE" width="210px"|Method name
+
 
!style="background:#EEE" width="*"|Description
+
Each peripheral block has a name, or ''side''. Although peripherals can now be attached to a computer using networking cables, the word ''side'' is a holdover from when peripherals needed to be directly next to the computer.
|-
+
 
|[[peripheral.isPresent]](side)
+
If the peripheral is next to the computer, its side is either "front", "back", "left", "right", "top" or "bottom". If the peripheral is attached by a cable, its side will follow the format "''type''_''id''", for example "printer_0".
|Returns '''true''' if a peripheral is present on ''side''.
+
 
|-
+
Peripheral functions are called '''methods''', a term borrowed from Java.
|[[peripheral.getType]](side)
+
 
|Returns the type or peripheral present on ''side'', nothing returned if ''side'' is empty.
+
{{API table|Peripheral|image=Grid disk.png|2=
|-
+
 
|[[peripheral.getMethods]](side)
+
{{API table/row|[[peripheral.isPresent]]({{type|string}} side)|{{type|boolean}}|
|Returns a table containing all methods for peripheral on ''side''.
+
Returns '''true''' if a peripheral is connected on ''side''.
|-
+
|odd}}
|[[peripheral.call]](side, methodName, param1, param2, ...)
+
 
|Sends a function call to peripheral located on ''side''. Return values match those of called method.<br />
+
{{API table/row|[[peripheral.getType]]({{type|string}} side)|{{type|string}} /{{type|nil}}|
'''Note:''' ''methodName'' is a string.
+
Returns the type of peripheral connected on ''side'', as a string.
|-
+
If no peripheral is connected, returns nil.
|[[peripheral.wrap]](side)
+
}}
|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 />
+
{{API table/row|[[peripheral.getMethods]]({{type|string}} side)|{{type|table}} /{{type|nil}}|
m.someMethod()<br />
+
Returns a list of the names of all the methods of the peripheral connected on ''side''.
''- is the same as -''<br />
+
If no peripheral is connected, returns nil.
[[peripheral.call]]("left","someMethod")
+
|odd}}
|}
+
 
 +
{{API table/row|[[peripheral.call]]({{type|string}} side, {{type|string}} method, ...)|any|
 +
Calls a method on a peripheral. The arguments (apart from ''side'' and ''method'') and the return values depend on the method being called.
 +
If no peripheral is connected, returns nil.
 +
}}
 +
 
 +
{{API table/row|[[peripheral.wrap]]({{type|string}} side)|{{type|table}} peripheral / {{type|nil}}|
 +
Returns a table of functions, allowing you to call peripheral methods as if they were normal Lua functions.
 +
If no peripheral is connected, returns nil.
 +
|odd}}
 +
 
 +
{{API table/row|[[peripheral.find]]({{type|string}} type [, {{type|function}} fnFilter( name, object )])|{{type|table}} peripheral / {{type|nil}}|
 +
Finds an attached peripheral of the given type and if found returns a table of functions, similar to [[peripheral.wrap]], allowing you to call peripheral methods as if they were normal Lua functions.
 +
If no peripheral of the given type is connected, it returns nil. '''''Requires ComputerCraft 1.6 or later.'''''
 +
|odd}}
 +
 
 +
{{API table/row|[[peripheral.getNames]]()|{{type|table}}|
 +
This function returns a table of all the sides that have a peripheral present. If the present peripheral is a wired modem any names of the peripherals that is on the network are also added to the table.
 +
|odd}}
 +
 
 +
}}
 +
 
 +
==Connecting 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]]. Place a Wired Modem on each peripheral you wish to connect, and then connect all of them with Networking Cables. Then right click each of the wired modems.
 +
 
 +
You should receive a message in your chat bar for each peripheral informing you of a successful connection, and the peripheral side.
  
==Events==
 
{| class="wikitable"
 
!style="background:#EEE" width="210px"|Event name
 
!style="background:#EEE" width="*"|Description
 
!style="background:#EEE" width="*"|Parameters
 
|-
 
|peripheral
 
|Fired when peripheral is attached
 
|side
 
|-
 
|peripheral_detach
 
|Fired when peripheral is removed
 
|side
 
|}
 
 
==Monitor==
 
==Monitor==
[[Monitor#Peripheral_Functions|Monitor Peripheral functions]] have been moved to the [[Monitor]] page.
+
[[Monitor]] and [[Advanced Monitor]] peripheral functions can be found on the [[Term (API)]] page. Note that the [[Colors (API)|Colors API]] can also be useful for designing colors for use on an advanced monitor.
In addition, the [[Advanced_Monitor#Peripheral_Functions|Advanced Monitor Peripheral functions]] have been moved to the [[Advanced Monitor]] page.
+
  
 
==Printer==
 
==Printer==
[[Printer#Peripheral_Functions|Printer Peripheral functions]] have been moved to the [[Printer]]page.
+
[[Printer#Printer API |Printer Peripheral functions]] have been moved to the [[Printer]] page.
  
 
==Computers==
 
==Computers==
 
[[Computer#Peripheral_Functions|Computer Peripheral functions]] have been moved to the [[Computer]] page.
 
[[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.
 
In addition, the [[Advanced_Computer#Peripheral_Functions|Advanced Computer Peripheral functions]] have been moved to the [[Advanced Computer]] page.
 +
 +
==Modem==
 +
[[Modem]] peripheral functions can be found on the [[Modem (API)]] page.
  
 
[[Category:APIs]]
 
[[Category:APIs]]

Latest revision as of 04:06, 9 November 2014

This article is about the Peripheral API. For APIs exposed when wrapping peripherals through peripheral.wrap() see Peripheral APIs.

The Peripheral API is for interacting with peripherals connected to the computer, such as the Disk Drive, the Advanced Monitor and Monitor. (More peripherals can be found under here).

Each peripheral block has a name, or side. Although peripherals can now be attached to a computer using networking cables, the word side is a holdover from when peripherals needed to be directly next to the computer.

If the peripheral is next to the computer, its side is either "front", "back", "left", "right", "top" or "bottom". If the peripheral is attached by a cable, its side will follow the format "type_id", for example "printer_0".

Peripheral functions are called methods, a term borrowed from Java.

Grid disk.png  Peripheral (API)
Function Return values Description
peripheral.isPresent(string side) boolean

Returns true if a peripheral is connected on side.

peripheral.getType(string side) string /nil

Returns the type of peripheral connected on side, as a string. If no peripheral is connected, returns nil.

peripheral.getMethods(string side) table /nil

Returns a list of the names of all the methods of the peripheral connected on side. If no peripheral is connected, returns nil.

peripheral.call(string side, string method, ...) any

Calls a method on a peripheral. The arguments (apart from side and method) and the return values depend on the method being called. If no peripheral is connected, returns nil.

peripheral.wrap(string side) table peripheral / nil

Returns a table of functions, allowing you to call peripheral methods as if they were normal Lua functions. If no peripheral is connected, returns nil.

peripheral.find(string type [, function fnFilter( name, object )]) table peripheral / nil

Finds an attached peripheral of the given type and if found returns a table of functions, similar to peripheral.wrap, allowing you to call peripheral methods as if they were normal Lua functions. If no peripheral of the given type is connected, it returns nil. Requires ComputerCraft 1.6 or later.

peripheral.getNames() table

This function returns a table of all the sides that have a peripheral present. If the present peripheral is a wired modem any names of the peripherals that is on the network are also added to the table.

Connecting 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. Place a Wired Modem on each peripheral you wish to connect, and then connect all of them with Networking Cables. Then right click each of the wired modems.

You should receive a message in your chat bar for each peripheral informing you of a successful connection, and the peripheral side.

Monitor

Monitor and Advanced Monitor peripheral functions can be found on the Term (API) page. Note that the Colors API can also be useful for designing colors for use on an advanced monitor.

Printer

Printer Peripheral functions have been moved to the Printer page.

Computers

Computer Peripheral functions have been moved to the Computer page. In addition, the Advanced Computer Peripheral functions have been moved to the Advanced Computer page.

Modem

Modem peripheral functions can be found on the Modem (API) page.