Object «mailbox»

It implements communication between robots in the network by means of the mailbox mechanism.

connect

Connects to the robot with a given IP address on a given port (or default port), gives it its on-board number, and registers with the "mailbox" network.

Syntax

mailbox.connect("ipAddress")
mailbox.connect("ipAddress", port)

mailbox.connect("ipAddress");
mailbox.connect("ipAddress", port);

As parameters, you must specify the IP address of the robot and the port. If no port is specified, the default port is used.

Example

mailbox.connect("192.168.0.20", 8889)

mailbox.connect("192.168.0.20", 8889);

hasMessages

Returns true if the robot received a new message.

Syntax

mailbox.hasMessages()

mailbox.hasMessages();

myHullNumber

Returns the onboard number of the robot.

Syntax

x = mailbox.myHullNumber()

var x = mailbox.myHullNumber();

newMessage

Sends a message after receiving a message.

Syntax

mailbox.newMessage.connect(lambda sender, message: print(message))

mailbox.newMessage.connect(function(sender, message) { print(message); });

The first parameter is the sender's onboard number, the second is the message itself.

receive

Gets a new message or blocks script execution until the message arrives.

Syntax

message = mailbox.receive()

var message = mailbox.receive();	

send

Sends the specified message to the robot with the specified board number (or all robots).

Syntax

mailbox.send("message")
mailbox.send(boardNumber, "message")

mailbox.send("message");
mailbox.send(boardNumber, "message");

As a parameter, you must specify the on-board number of the robot to which you want to send the message and the message. If no on-board number is specified, the message is sent to all robots registered in the network.

Example

mailbox.send(1, "Hello") # Sending a message to a robot with board number 1

mailbox.send(1, "Hello"); // Sending a message to a robot with board number 1