TJF1960 Posted December 31, 2024 Posted December 31, 2024 WEBCONTROL832 PLUGIN SETUP GUIDE ** (Note, if you are upgrading from the Non-Production Store version to Production Store version, follow the steps at the bottom of this page). *** Before installing ANY Plugin (nodeserver) ALWAYS do a complete backup of PGx3 and IoX beforehand. (I always do another right after installation for good measure). The WebControl832 Plugin connects to a WebControl8 or WebControl32 device, polling its data and updating your IoX system with the following information: 1. Node Server Status: Displays "Connected," "Not Connected," or "Failed." 2. Heartbeat: Alternates between 1 and -1 when connected, updating with each shortPoll. Displays 0 when disconnected. 3. NetBIOS Name: The name assigned to your WebControl device in its network configuration. 4. Date and Time: The current date and time reported by the WebControl device. 5. IP Address: The IP address assigned to the WebControl device. 6. Firmware Version: The firmware version installed on the WebControl device. POLLING CONFIGURATION • shortPoll: Updates only nodes with changed values since the last poll. Default: 10 seconds. • longPoll: Forces an update of all node values. Default: 10 minutes. ________________________________________ CUSTOM PARAMETERS Configure the following parameters to match your WebControl device settings: • IP_Address: The IP address of the WebControl device. • Port: The WebControl's network port (default: 80). • Username: The WebControl login username (default: admin). • Password: The WebControl login password (default: password). • Json_Nodes_Names: A single-line JSON string specifying which nodes to create and their custom names. See examples below. • Custom_Name: A custom name for the WebControl device (default: WebControl832). ________________________________________ NODE CREATION This plugin only creates the Controller Node by default. Additional nodes must be specified in the Json_Nodes_Names parameter. This ensures that only the nodes you need are created, reducing resource usage. JSON String Format: The JSON string uses a key-value structure: • Key: The node type (e.g., aip1 for Analog Input 1). • Value: The custom name for the node. For example, to create a node for Analog Input 1 and name it "My Analog Input," use: {"aip1": "My Analog Input"} To create multiple nodes (e.g., one Analog Input, one Output, and two Temp Sensors): {"aip1": "Analog Input 1", "op1": "Output 1", "ts1": "Temp Sensor 1", "ts8": "Temp Sensor 8"} ________________________________________ AVAILABLE JSON KEYS Below are the keys and their corresponding WebControl node types: WEBCONTROL 8 • aip1 to aip3: Analog Inputs 1 to 3 • counter: Counter • fcounter: Frequency Counter • hs1: Humidity Sensor • ip1 to ip8: Inputs 1 to 8 • op1 to op8: Outputs 1 to 8 • ts1 to ts8: Temperature Sensors 1 to 8 • var1 to var8: Variables 1 to 8 WEBCONTROL 32 • aip1 to aip8: Analog Inputs 1 to 8 • cnt1 to cnt3: Counters 1 to 3 • hs1: Humidity Sensor • ip1 to ip16: Inputs 1 to 16 • op1 to op16: Outputs 1 to 16 • ts1 to ts16: Temperature Sensors 1 to 16 • var1 to var16: Variables 1 to 16 ________________________________________ EXAMPLE JSON STRINGS WEBCONTROL 8 Here’s a complete JSON string for creating all possible nodes on a WebControl 8 board: {"aip1": "Analog Input 1", "aip2": "Analog Input 2", "aip3": "Analog Input 3", "counter": "Counter", "fcounter": "Frequency Counter", "hs1": "Humidity Sensor", "ip1": "Input 1", "ip2": "Input 2", "ip3": "Input 3", "ip4": "Input 4", "ip5": "Input 5", "ip6": "Input 6", "ip7": "Input 7", "ip8": "Input 8", "op1": "Output 1", "op2": "Output 2", "op3": "Output 3", "op4": "Output 4", "op5": "Output 5", "op6": "Output 6", "op7": "Output 7", "op8": "Output 8", "ts1": "Temp Sensor 1", "ts2": "Temp Sensor 2", "ts3": "Temp Sensor 3", "ts4": "Temp Sensor 4", "ts5": "Temp Sensor 5", "ts6": "Temp Sensor 6", "ts7": "Temp Sensor 7", "ts8": "Temp Sensor 8", "var1": "Variable 1", "var2": "Variable 2", "var3": "Variable 3", "var4": "Variable 4", "var5": "Variable 5", "var6": "Variable 6", "var7": "Variable 7", "var8": "Variable 8"} WEBCONTROL 32 Here’s a complete JSON string for creating all possible nodes on a WebControl 32 board: {"aip1": "Analog Input 1", "aip2": "Analog Input 2", "aip3": "Analog Input 3", "aip4": "Analog Input 4", "aip5": "Analog Input 5", "aip6": "Analog Input 6", "aip7": "Analog Input 7", "aip8": "Analog Input 8", "cnt1": "Counter 1", "cnt2": "Counter 2", "cnt3": "Counter 3", "hs1": "Humidity Sensor", "ip1": "Input 1", "ip2": "Input 2", "ip3": "Input 3", "ip4": "Input 4", "ip5": "Input 5", "ip6": "Input 6", "ip7": "Input 7", "ip8": "Input 8", "ip9": "Input 9", "ip10": "Input 10", "ip11": "Input 11", "ip12": "Input 12", "ip13": "Input 13", "ip14": "Input 14", "ip15": "Input 15", "ip16": "Input 16", "op1": "Output 1", "op2": "Output 2", "op3": "Output 3", "op4": "Output 4", "op5": "Output 5", "op6": "Output 6", "op7": "Output 7", "op8": "Output 8", "op9": "Output 9", "op10": "Output 10", "op11": "Output 11", "op12": "Output 12", "op13": "Output 13", "op14": "Output 14", "op15": "Output 15", "op16": "Output 16", "ts1": "Temp Sensor 1", "ts2": "Temp Sensor 2", "ts3": "Temp Sensor 3", "ts4": "Temp Sensor 4", "ts5": "Temp Sensor 5", "ts6": "Temp Sensor 6", "ts7": "Temp Sensor 7", "ts8": "Temp Sensor 8", "ts9": "Temp Sensor 9", "ts10": "Temp Sensor 10", "ts11": "Temp Sensor 11", "ts12": "Temp Sensor 12", "ts13": "Temp Sensor 13", "ts14": "Temp Sensor 14", "ts15": "Temp Sensor 15", "ts16": "Temp Sensor 16", "var1": "Variable 1", "var2": "Variable 2", "var3": "Variable 3", "var4": "Variable 4", "var5": "Variable 5", "var6": "Variable 6", "var7": "Variable 7", "var8": "Variable 8", "var9": "Variable 9", "var10": "Variable 10", "var11": "Variable 11", "var12": "Variable 12", "var13": "Variable 13", "var14": "Variable 14", "var15": "Variable 15", "var16": "Variable 16"} ________________________________________ After updating all custom parameters, click Save. The controller node (NetBIOS name, date/time, IP address, and firmware version) will update during the next longPoll. Additional nodes will begin updating shortly after saving or restarting the plugin. ________________________________________ ** If you have the Non-Production version installed and would like to upgrade to the Production version, Follow the steps below. 1) Backup PGx3 and IoX completely. 2) Go to the PGx3 Production store and find WebControl832 and select. 3) On the install page, verify your beta version and slot number is listed. Then select install. 4) On the pop up page you will see a box labeled Reinstall Here for each instance of the plugin you have installed. 5) Select Reinstall Here button and wait 30 seconds for the plugin to update and start up again. Do this for every instance. 6) Backup PGx3 and IoX completely for good measure. 12/31/2024 Production start version v1.0.3 1
Recommended Posts