This is the description of the Mathematica API bindings for the IP Connection. The IP Connection manages the communication between the API bindings and the Brick Daemon or a WIFI/Ethernet Extension. Before Bricks and Bricklets can be controlled using their API an IP Connection has to be created and its TCP/IP connection has to be established.
An installation guide for the Mathematica API bindings is part of their general description.
The example code below is Public Domain (CC0 1.0).
Download (ExampleEnumerate.nb)
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 | Needs["NETLink`"]
LoadNETAssembly["Tinkerforge",NotebookDirectory[]<>".."]
host="localhost"
port=4223
(* Create IPConnection *)
ipcon=NETNew["Tinkerforge.IPConnection"]
ipcon@Connect[host,port]
(* Print incoming enumeration information *)
EnumerateCB[sender_,uid_,connectedUid_,position_,hardwareVersion_,firmwareVersion_,
deviceIdentifier_,enumerationType_]:=
Module[{},
Print["UID: "<>uid];
Print["Enumeration Type: "<>ToString[enumerationType]];
If[enumerationType!=Tinkerforge`IPConnection`ENUMERATIONUTYPEUDISCONNECTED,
Print["Connected UID: "<>connectedUid];
Print["Position: "<>FromCharacterCode[position]];
Print["Hardware Version: "<>StringJoin[Riffle[Map[ToString,hardwareVersion],{".","."}]]];
Print["Firmware Version: "<>StringJoin[Riffle[Map[ToString,firmwareVersion],{".","."}]]];
Print["Device Identifier: "<>ToString[deviceIdentifier]]
];
Print[""]
]
AddEventHandler[ipcon@EnumerateCallback,EnumerateCB]
(* Trigger enumerate *)
ipcon@Enumerate[]
Input["Click OK to exit"]
(* Clean up *)
ipcon@Disconnect[]
ReleaseNETObject[ipcon]
|
Download (ExampleAuthenticate.nb)
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 | Needs["NETLink`"]
LoadNETAssembly["Tinkerforge",NotebookDirectory[]<>".."]
host="localhost"
port=4223
secret="My Authentication Secret!"
(* Create IPConnection *)
ipcon=NETNew["Tinkerforge.IPConnection"]
(* Authenticate each time the connection got (re-)established *)
ConnectedCB[sender_,connectReason_]:=
Module[{},
If[connectReason==Tinkerforge`IPConnection`CONNECTUREASONUREQUEST,Print["Connected by request"]];
If[connectReason==Tinkerforge`IPConnection`CONNECTUREASONUAUTOURECONNECT,Print["Auto-Reconnect"]];
(* Authenticate first... *)
sender@Authenticate[secret];
(* ...then trigger enumerate *)
sender@Enumerate[]
]
AddEventHandler[ipcon@Connected,ConnectedCB]
(* Print incoming enumeration information *)
EnumerateCB[sender_,uid_,connectedUid_,position_,hardwareVersion_,firmwareVersion_,
deviceIdentifier_,enumerationType_]:=
Print["UID: "<>uid<>", Enumeration Type: "<>ToString[enumerationType]]
AddEventHandler[ipcon@EnumerateCallback,EnumerateCB]
(* Connect to brickd *)
ipcon@Connect[host,port]
Input["Click OK to exit"]
(* Clean up *)
ipcon@Disconnect[]
ReleaseNETObject[ipcon]
|
The namespace for the IPConnection is Tinkerforge.*.
Returns: |
|
---|
Creates an IP Connection object that can be used to enumerate the available devices. It is also required for the constructor of Bricks and Bricklets.
ipcon=NETNew["Tinkerforge.IPConnection"]
The .NET runtime has built-in garbage collection that frees objects that are no longer in use by a program. But because Mathematica can not automatically tell when a Mathematica "program" doesn't use a .NET object anymore, this has to be done by the program. For this the ReleaseNETObject[] function is used in the examples.
For further information about object management in .NET/Link see the corresponding Mathematica .NET/Link documentation.
Parameters: |
|
---|
Creates a TCP/IP connection to the given host and port. The host and port can refer to a Brick Daemon or to a WIFI/Ethernet Extension.
Devices can only be controlled when the connection was established successfully.
Blocks until the connection is established and throws an exception if there is no Brick Daemon or WIFI/Ethernet Extension listening at the given host and port.
Disconnects the TCP/IP connection from the Brick Daemon or the WIFI/Ethernet Extension.
Parameters: |
|
---|
Performs an authentication handshake with the connected Brick Daemon or WIFI/Ethernet Extension. If the handshake succeeds the connection switches from non-authenticated to authenticated state and communication can continue as normal. If the handshake fails then the connection gets closed. Authentication can fail if the wrong secret was used or if authentication is not enabled at all on the Brick Daemon or the WIFI/Ethernet Extension.
See the authentication tutorial for more information.
New in version 2.1.0.
Returns: |
|
---|
Can return the following states:
Parameters: |
|
---|
Enables or disables auto-reconnect. If auto-reconnect is enabled, the IP Connection will try to reconnect to the previously given host and port, if the connection is lost.
Default value is True.
Returns: |
|
---|
Returns True if auto-reconnect is enabled, False otherwise.
Parameters: |
|
---|
Sets the timeout in milliseconds for getters and for setters for which the response expected flag is activated.
Default timeout is 2500.
Parameters: |
|
---|
Returns the timeout as set by SetTimeout[].
Broadcasts an enumerate request. All devices will respond with an enumerate callback.
Stops the current thread until Unwait[] is called.
This is useful if you rely solely on callbacks for events, if you want to wait for a specific callback or if the IP Connection was created in a thread.
Wait and Unwait act in the same way as Acquire and Release of a semaphore.
Callbacks can be registered to be notified about events. The registration is done by appending your callback handler to the corresponding event:
Callback[sender_,value_]:=Print["Value: "<>ToString[value]]
AddEventHandler[ipcon@Example,Callback]
For further information about event handling using .NET/Link see the corresponding Mathematica .NET/Link documentation.
The available events are described below.
Parameters: |
|
---|
The event receives seven parameters:
Possible enumeration types are:
It should be possible to implement plug-and-play functionality with this (as is done in Brick Viewer).
The device identifier numbers can be found here. There are also constants for these numbers named following this pattern:
<device-class>`DEVICEUIDENTIFIER
For example: BrickMaster`DEVICEUIDENTIFIER or BrickletAmbientLight`DEVICEUIDENTIFIER.
Parameters: |
|
---|
This event is triggered whenever the IP Connection got connected to a Brick Daemon or to a WIFI/Ethernet Extension, possible reasons are:
Parameters: |
|
---|
This event is triggered whenever the IP Connection got disconnected from a Brick Daemon or to a WIFI/Ethernet Extension, possible reasons are: