plugins:02_infojson
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision Next revision Both sides next revision | ||
|
plugins:02_infojson [2018/08/11 16:50] James Sentman updated for APIv2 |
plugins:02_infojson [2018/08/19 14:28] James Sentman removed allowTCP and allowUDP as those don’t matter anymore |
||
|---|---|---|---|
| Line 57: | Line 57: | ||
| ===allowTCP=== | ===allowTCP=== | ||
| - | OPTIONAL: (boolean) defaults to True. Allows for the opening of an outgoing TCP connection. If absent or present and True this will allow the selection of "Remote IP Address" as a connection type. If present and false then the option of selecting this will be greyed out. When this option is selected in the port popup an extra interface element will be added allowing for the entry of a DNS name or IP address and a port number. If your device can only be connected to over TCP you may specify the "portSelectOutgoing" option below. You can get the user entered address and port via the xtension.settings object in the plugin using the xtKeyRemoteAddress and xtKeyRemotePort constants like: | + | OPTIONAL: (boolean) defaults to True. If true then the Outgoing TCP Connection option will be enabled in the port popup. There are some devices that might be connected via a serial port or via a serial to ethernet type adaptor. If selected by the user additional user interface will be inserted for them to enter a remote address and port. If your plugin only makes outgoing network connections then you should instead include the key “portSelectOutput” as below to force this to be the only selection. |
| + | |||
| + | You can get the user entered address and port via the XTension.settings object in the plugin using the xtKeyRemoteAddress and xtKeyRemotePort constants like: | ||
| <code> | <code> | ||
| myAddress = xtension.settings.get( xtKeyRemoteAddress) | myAddress = xtension.settings.get( xtKeyRemoteAddress) | ||
| Line 81: | Line 83: | ||
| ==TCPListen== | ==TCPListen== | ||
| - | OPTIONAL: (boolean) defaults to false. If present and true the user will have the option of selecting "Listen for incoming TCP Connections" from the communications popup. Once selected an additional interface to set up an incoming networking system will be displayed. If your plugin can communicate only by incoming connections then you should specify the "portSelectIncoming" parameter below. | + | OPTIONAL: (boolean) defaults to false. If present and true the user will have the option of selecting "Listen for incoming TCP Connections" from the communications popup. Once selected an additional UI section will be inserted into the window to set up the listening port and optionally the bonjour names. If your plugin can communicate only by incoming connections then you should specify the "portSelectIncoming" parameter below to force this selection. |
| ==portSelectIncoming== | ==portSelectIncoming== | ||
| Line 88: | Line 90: | ||
| ==defaultPort== | ==defaultPort== | ||
| OPTIONAL: (integer) if present this will be filled in to the port field for the incoming communication field. | OPTIONAL: (integer) if present this will be filled in to the port field for the incoming communication field. | ||
| - | |||
| - | ==allowTCP== | ||
| - | OPTIONAL: (boolean) defaults to True. If your interface needs to accept incoming TCP communications this should be left out or set to true. | ||
| - | |||
| - | ==allowUDP== | ||
| - | OPTIONAL: (boolean) defaults to False. If your inteface needs to accept UDP packets on the specified port you should include this parameter as True. | ||
| ==allowBonjour== | ==allowBonjour== | ||
plugins/02_infojson.txt · Last modified: 2018/08/24 15:14 by James Sentman
Page Tools
Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
