A Slot object is the JavaScript interface with a single communication slot on a LAN Bridge device
Do not create this object directly. You can obtain instances of this class using the CFLink.LANBridge.getSlot function.
Do not create this object directly. You can obtain instances of this class using the CFLink.LANBridge.getSlot function.
Members
-
<static, constant> CONFIGURATION_CHANGE
-
This event is being sent when a communication slot's configuration on the LANBridge changes. Your callback function should have the prototype: function(event, sender, commSlot) event is the name of this event sender is the CFLink.LANBridge object that owns this CFLink.LANBridge.Slot commSlot is is the CFLink.LANBridge.Slot object itself
Methods
bridge
(
targetSlot
,
targetDevice
,
targetModule
,
outgoingWrapperCommand
,
incomingCommandFilter
)
Parameters:
Name | Type | Description |
---|---|---|
targetSlot |
Number | The slot to forward data to/from. Numbers 1,2,11-20 only. |
targetDevice |
string | if targetSlot is 1 (LANBridge's CFLink slot), only messages from the specified device's CFLinkID will be forwarded |
targetModule |
string | if targetSlot is 1 (LANBridge's CFLink slot) and targetDevice not empty and addresses a CFLink device that contains modules, targetModule is the module we're bridging to within the targetDevice |
outgoingWrapperCommand |
{string} if targetSlot is 1 (LANBridge's CFLink slot), you can set a 7 char CFLink wrapper command that will be used to wrap all data sent from this slot to the other slot, effectively turning raw data into valid CFLink packets | |
incomingCommandFilter |
{string} if targetSlot is 1 (LANBridge's CFLink slot), you can set a 7 char CFLink command filter that will filter out all packets coming from the target slot, AND unwrapping the payload, effectively extracting raw data from incoming CFLink packets |
Bridge this slot to another slot. You can setup bridges for slots 2 (RS232) and 11 - 20 only
Changes are effective after a device reset.
configureForTCP
(
mode
,
ipAddress
,
port
,
timeout
,
maxConnections
,
echo
)
Parameters:
Name | Description | |
---|---|---|
mode |
{string} "S" for TCP server slot, "C" for TCP client slot | |
ipAddress |
{string} for TCP servers slots, "0.0.0.0" to allow any client to connect or the IP address of the only allowed client. For TCP client slots, the IP address of the remote to connect to. | |
port |
{Number} the TCP port number to assign to the slot | |
timeout |
{Number} The time in seconds to hold a TCP connection open for without any data transmissions. Set to 0 to disable. | |
maxConnections |
{Number} The maximum number of simultaneous connections a TCP Server slot can handle. Set to 0 for unlimited | |
echo |
{Number} Option to echo data received on a TCP Server slot from any TCP Client to all other connected clients. 1 to enable, 0 to disable. Ignored for TCP Client slots. |
Configure this slot for TCP communications. The configuration command is being sent immediately to the device's slot,
but the changes won't be effective until the device is reset (therefore, we don't update the properties of this
JavaScript object immediately)
configureForUDP
(
mode
,
ipAddress
,
port
)
Parameters:
Name | Description | |
---|---|---|
mode |
{string} "U" for unicast UDP, "M" for multicast, "B" for broadcast | |
ipAddress |
the IP address to set for this | |
port |
the port on the remote |
Configure this slot for UDP communications. The configuration command is being sent immediately to the device's slot,
but the changes won't be effective until the device is reset (therefore, we don't update the properties of this
JavaScript object immediately)
disableSlot
(
)
Disable this slot. The configuration command is being sent immediately to the device's slot,
but the changes won't be effective until the device is reset (therefore, we don't update the properties of this
JavaScript object immediately)
unbridge
(
)
Unsubscribe a slot from any subscription it previously had