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 | ||
|
plugins:02_infojson [2018/08/19 14:11] James Sentman [TCPListen] |
plugins:02_infojson [2018/08/24 15:14] (current) James Sentman [allowBonjour] added info that XTension will take care of it |
||
|---|---|---|---|
| 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 63: | Line 65: | ||
| </code> | </code> | ||
| - | ==portSelectOutgoing== | + | ===portSelectOutgoing=== |
| OPTIONAL: (boolean) if present and True the communications selection popup will be forced to select "remote tcp connection" and then disabled so that no other comm type can be selected by the user. | OPTIONAL: (boolean) if present and True the communications selection popup will be forced to select "remote tcp connection" and then disabled so that no other comm type can be selected by the user. | ||
| 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== | ||
| - | OPTIONAL: (boolean) defaults to True. Allows for you to register a bonjour, zero-conf or mDNS name on the local network making it easier to find. | + | OPTIONAL: (boolean) defaults to True. Allows for you to register a bonjour, zero-conf or mDNS name on the local network making it easier to find. The actual work of creating the mDNS record is handled by XTension. Your plugin does not have to do anything other than specify that you’d like it to be an option and supply the default service type string. |
| ==defaultBonjourName== | ==defaultBonjourName== | ||
| OPTIONAL: (string) if present this will be offered as the default Bonjour name for the service you are registering. This is the DNS name that other devices will use to find your server. | OPTIONAL: (string) if present this will be offered as the default Bonjour name for the service you are registering. This is the DNS name that other devices will use to find your server. | ||
plugins/02_infojson.1534687873.txt.gz · Last modified: 2018/08/19 14:11 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
