Modem (API) - Revision history

Bomb Bloke: Additional functions for wired modems.

2016-01-09T03:33:13Z

Additional functions for wired modems.

Bomb Bloke at 10:52, 27 December 2015

2015-12-27T10:52:30Z

Bomb Bloke at 13:57, 14 June 2015

2015-06-14T13:57:24Z

Bomb Bloke at 10:00, 30 May 2015

2015-05-30T10:00:13Z

Apemanzilla at 13:55, 9 April 2015

2015-04-09T13:55:37Z

Awsmazinggenius: typo, it said "bollean" instead of "boolean"

2014-05-18T15:47:17Z

typo, it said "bollean" instead of "boolean"

MKlegoman357: Recreated method function table using {{API table}} tag, event table uning {{Event}} tag, linked functions in examples

2014-04-09T15:15:24Z

Recreated method function table using {{API table}} tag, event table uning {{Event}} tag, linked functions in examples

Oeed: Added peripheral API message

2014-03-26T07:16:38Z

Added peripheral API message

Cranium: WE DON'T USE INT ANYMORE

2013-10-04T11:08:57Z

WE DON'T USE INT ANYMORE

Chainmanner at 11:24, 21 September 2013

2013-09-21T11:24:11Z

@@ Line 1: / Line 1: @@
 :''This page is for the modem API. For the blocks, see [[Modem]].''
 {{PeripheralAPI}}
-Modem channels are essentially networks which can be [[modem.open|opened]], [[modem.close|closed]] and [[modem_message_(event)|listened]] on by any [[Computer]] within range, without need of independant computer IDs. To interact with channels, one must [[peripheral.wrap|wrap]] or interact directly with the peripheral as opposed to the previous interaction with the [[Rednet_(API)|Rednet API]].
+Available to [[peripheral.wrap|wrapped]] [[Wireless Modem|Wireless]], [[Ender Modem|Ender]], or [[Wired Modem|Wired]] Modems.
 {{API table|Modem|image=Grid disk.png|2=
@@ Line 43: / Line 44: @@
 |{{type|boolean}} isWireless
 |Returns if the modem is wireless or wired.}}
 }}
@@ Line 55: / Line 84: @@
 |desc=Fired when a modem message is received.}}
-==Sending Messages==
+== Sending Messages ==
-Sending messages is simple and does not require that you open any channels. Simply use the transmit function like so:
+Sending a message is simple and does not require that you open any channels. Simply use the transmit function like so:
-  local modem = [[peripheral.wrap]]("right") --Wraps the modem on the right side.
+  local modem = [[peripheral.wrap]]("right") -- Wraps the modem on the right side.
   [[peripheral.call]]("right", "transmit", 3, 1, "This will also work!")
 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 ==
-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:
+Receiving a message requires that you be familiar with [[os.pullEvent|events]]. An example:
   local modem = [[peripheral.wrap]]("left")
-  [[modem.open]](3)--Open channel 3 so that we can listen on it
+  [[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 just received a message on channel: "..senderChannel)
-  print("I should apparently reply on: "..replyChannel)
+  print("I should apparently reply on channel: "..replyChannel)
-  print("The modem receiving this is located on the "..modemSide.." side")
+  print("The modem receiving this is located on my "..modemSide.." side")
   print("The message was: "..message)
-  print("The sender is: "..senderDistance.." blocks away from me.")
+  print("The sender is: "..(senderDistance or "an unknown number of").." blocks away from me.")
-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.
+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 [[modem_message_(event)|the "modem_message" event]] is captured, it returns the arguments: event, modemSide, senderChannel, replyChannel, message, senderDistance. I captured these and then printed them out.
 == Modem Limitations ==
-* You can only open 128 channels at any given time.
+* You can only open 128 channels at any given time, per modem.
-* The maximum channel you can open is 65535.
+* The highest channel you can open is 65535.
 * You can listen on more than one channel at a time. For example, if the modem has channel 3 and channel 5 open, and somebody sends a message on channel 5, the modem will receive it. If a message is sent on channel 3, the modem will also receive the message.
 * 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 using the Modem API, messages are still available to any computer listening on the sent channel.
+* Modems and channels are not secure - if you are sending a message using the Modem API, messages are still available to any computer listening on the sent channel. By extension, the [[rednet (API)|Rednet API]] (which handles your modems for you using their peripheral APIs) is also insecure.
 [[Category:Peripheral APIs]]

@@ Line 3: / Line 3: @@
 {{PeripheralAPI}}
-Available to [[Wireless Modem|Wireless]] and [[Wired Modem|Wired]] Modems.
+Available to [[Wireless Modem|Wireless]], [[Ender Modem|Ender]], and [[Wired Modem|Wired]] Modems.
 Modem channels are essentially networks which can be [[modem.open|opened]], [[modem.close|closed]] and [[modem_message_(event)|listened]] on by any [[Computer]] within range, without need of independant computer IDs. To interact with channels, one must [[peripheral.wrap|wrap]] or interact directly with the peripheral as opposed to the previous interaction with the [[Rednet_(API)|Rednet API]].

@@ Line 34: / Line 34: @@
 {{API table/row
-|[[modem.transmit|''modem''.transmit]]({{type|number}} channel, {{type|number}} replyChannel, message)
+|[[modem.transmit|''modem''.transmit]]({{type|number}} channel, {{type|number}} replyChannel, {{type|any}} message)
 |{{type|nil}}
 |Transmits a message on the specified channel.

← Older revision		Revision as of 10:00, 30 May 2015
Line 2:		Line 2:

	{{PeripheralAPI}}		{{PeripheralAPI}}
		+
		+	Available to [[Wireless Modem\|Wireless]] and [[Wired Modem\|Wired]] Modems.

	Modem channels are essentially networks which can be [[modem.open\|opened]], [[modem.close\|closed]] and [[modem_message_(event)\|listened]] on by any [[Computer]] within range, without need of independant computer IDs. To interact with channels, one must [[peripheral.wrap\|wrap]] or interact directly with the peripheral as opposed to the previous interaction with the [[Rednet_(API)\|Rednet API]].		Modem channels are essentially networks which can be [[modem.open\|opened]], [[modem.close\|closed]] and [[modem_message_(event)\|listened]] on by any [[Computer]] within range, without need of independant computer IDs. To interact with channels, one must [[peripheral.wrap\|wrap]] or interact directly with the peripheral as opposed to the previous interaction with the [[Rednet_(API)\|Rednet API]].

@@ Line 32: / Line 32: @@
 {{API table/row
-|[[modem.transmit|''modem''.transmit]]({{type|number}} channel, {{type|number}} replyChannel, {{type|string}} message)
+|[[modem.transmit|''modem''.transmit]]({{type|number}} channel, {{type|number}} replyChannel, message)
 |{{type|nil}}
 |Transmits a message on the specified channel.
@@ Line 49: / Line 49: @@
 |return2={{type|number}} senderChannel
 |return3={{type|number}} replyChannel
-|return4={{type|string}} message
+|return4= message
 |return5={{type|number}} distance
 |desc=Fired when a modem message is received.}}

@@ Line 3: / Line 3: @@
 {{PeripheralAPI}}
-Modem channels are essentially networks which can be opened, closed and listened on by any computer within range, without need of independant computer IDs. To interact with channels, one must wrap or interact directly with the peripheral as opposed to the previous interaction with the Rednet API.
+Modem channels are essentially networks which can be [[modem.open|opened]], [[modem.close|closed]] and [[modem_message_(event)|listened]] on by any [[Computer]] within range, without need of independant computer IDs. To interact with channels, one must [[peripheral.wrap|wrap]] or interact directly with the peripheral as opposed to the previous interaction with the [[Rednet_(API)|Rednet API]].
-'''There is not an actual API called "modem". This is the API for wrapped modem peripherals.'''
+This is not an actual API called "modem". This is the API for [[peripheral.wrap|wrapped]] modem peripherals.
-<table style="width: 100%; border: solid 1px black; margin: 2px; border-spacing: 0px;">
+{{API table|Modem|image=Grid disk.png|2=
-<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]]&nbsp;&nbsp;
-Modem (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>
+{{API table/row
-<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[modem.isOpen]]({{type|number}} channel)</td>
+{{API table/row
-<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Checks to see if ''channel'' is open</td></tr>
+|[[modem.open|''modem''.open]]({{type|number}} channel)
-<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[modem.open]]({{type|number}} channel)</td>
+{{API table/row
-<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Opens ''channel'' to allow for listening. The channel specified must be larger than 0 and less than 65535</td></tr>
+|[[modem.close|''modem''.close]]({{type|number}} channel)
-<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[modem.close]]({{type|number}} channel)</td>
+{{API table/row
-<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Closes an open channel to disallow listening</td></tr>
+|[[modem.closeAll|''modem''.closeAll]]()
-<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[modem.closeAll]]()</td>
+{{API table/row
-<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Closes all open channels</td></tr>
+|[[modem.transmit|''modem''.transmit]]({{type|number}} channel, {{type|number}} replyChannel, {{type|string}} message)
-<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[modem.transmit]]({{type|number}} channel, {{type|number}} replyChannel, {{type|string}} message)</td>
+{{API table/row
-<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Transmits a message on the specified channel</td></tr>
+|[[modem.isWireless|''modem''.isWireless]]()
-<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[modem.isWireless]]()</td>
+}}
-<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns true if the modem is wireless; false if it is wired</td></tr>
-</table>
+{{Event
-{| class="wikitable" width="100%"
+|name=modem_message
-! colspan="1" | Event Name
+|return1={{type|string}} modemSide
-! colspan="1" | Description
+|return2={{type|number}} senderChannel
-! colspan="1" | Parameters
+|return3={{type|number}} replyChannel
-|-
+|return4={{type|string}} message
-! scope="row" | modem_message
+|return5={{type|number}} distance
-|Fired when a modem message is received.
+|desc=Fired when a modem message is received.}}
-|{{type|string}} modemSide, {{type|number}} senderChannel, {{type|number}} replyChannel, {{type|string}} message, {{type|number}} distance
 |}
 ==Sending Messages==
 Sending messages is simple and does not require that you open any channels. Simply use the transmit function like so:
-  local modem = peripheral.wrap("right") --Wraps the modem on the right side.
+  local modem = [[peripheral.wrap]]("right") --Wraps the modem on the right side.
   modem.transmit(3, 1, "Hello world!")
-  peripheral.call("right", "transmit", 3, 1, "This will also work!")
+ [[modem.transmit]](3, 1, "Hello world!")
-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.
+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:
-  local modem = peripheral.wrap("left")
+  local modem = [[peripheral.wrap]]("left")
-  modem.open(3)--Open channel 3 so that we can listen on it
+  [[modem.open]](3)--Open channel 3 so that we can listen on it
   local event, modemSide, senderChannel,
-    replyChannel, message, senderDistance = os.pullEvent("modem_message")
+    replyChannel, message, senderDistance = [[os.pullEvent]]("modem_message")
   print("I just received a message from: "..senderChannel)
   print("I should apparently reply on: "..replyChannel)
@@ Line 63: / Line 75: @@
   print("The sender is: "..senderDistance.." blocks away from me.")
-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.
+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.
 == Modem Limitations ==

← Older revision		Revision as of 07:16, 26 March 2014
Line 1:		Line 1:
	:''This page is for the modem API. For the blocks, see [[Modem]].''		:''This page is for the modem API. For the blocks, see [[Modem]].''
		+
		+	{{PeripheralAPI}}

	Modem channels are essentially networks which can be opened, closed and listened on by any computer within range, without need of independant computer IDs. To interact with channels, one must wrap or interact directly with the peripheral as opposed to the previous interaction with the Rednet API.		Modem channels are essentially networks which can be opened, closed and listened on by any computer within range, without need of independant computer IDs. To interact with channels, one must wrap or interact directly with the peripheral as opposed to the previous interaction with the Rednet API.