User Guide for IoTBuddy models including: 154-0046-0B Web Configuration Manual, 154-0046-0B, Web Configuration Manual, Configuration Manual
(Coming Soon!) IoT Buddy
File Info : application/pdf, 24 Pages, 2.89MB
DocumentDocumentRev. 0A 0B Release Date 10/27/23 By Description of Change ECR Initial Release --- Updated Screenshots, Descriptions, and Menus IOTBuddy Web Configuration Guide Page 1 of 24 154-0054-0B Table of Contents Wi-Fi Connection .......................................................................................................................................... 3 Connect using QR Code to Access Point (AP): .......................................................................................... 3 Manually Connect to Access Point (AP):................................................................................................... 4 Network Configuration ............................................................................................................................. 6 Ethernet or Power over Ethernet (POE) Connection.................................................................................... 8 Cloud Service Setup (Remote Output Connection) ................................................................................ 11 Setting the Modbus Settings for the Connected Device ............................................................................ 12 Modbus Settings (Local Device).............................................................................................................. 12 Setting the Data Point Settings for the Connected Device ......................................................................... 13 Data Point Settings (Local Modbus Device) ............................................................................................ 13 Data Point Settings (BACnet IP) .............................................................................................................. 14 Data Point Settings (Modbus TCP).......................................................................................................... 17 Analog Settings (Local Device)................................................................................................................ 18 Loading Configuration/Firmware files into the IoTBuddy .......................................................................... 19 Access and Steps..................................................................................................................................... 19 App Provisioning of the IoTBuddy .............................................................................................................. 20 Setup....................................................................................................................................................... 20 IP Address Retrieval using the Sync App................................................................................................. 23 -- IOTBuddy Web Configuration Guide Page 2 of 24 154-0054-0B Wi-Fi Connection Follow installation instructions to wire IoTBuddy to desired Modbus or analog device. The QR Code for the Manual is included below: Once powered, IoTBuddy will host an access point for 5 minutes. To re-enable the access point, press the button on the IoTBuddy. Connect using QR Code to Access Point (AP): 1. Scan the QR code on the label of the IoTBuddy device. This can be used to join the IoTBuddy's hosted network. 2. Open a browser; go to https://4.3.2.1 3. A non-private connection status may appear, please approve and "visit website" a. You may need to hit "refresh" after clicking the "visit website" link. 4. Log in using the default credentials: · username: admin · password: admin 5. Navigate using the 3-line "hamburger" menu on the top right. Refer to the other sections of this document for details of each setup screen. admin admin IOTBuddy Web Configuration Guide Page 3 of 24 154-0054-0B Manually Connect to Access Point (AP): 1. Open your Wi-Fi network page and find the IOTB that matches the serial number printed on your IoTBuddy label. 2. Enter the network security key: password 3. Go to https://4.3.2.1 4. Your browser may indicate a non-private connection. Find the "proceed" button near the bottom of the warnings; you may need to click the subtle link labeled "advanced" or "show more" first. IOTBuddy Web Configuration Guide Page 4 of 24 154-0054-0B 5. Log in using the default credentials: · username: admin · password: admin admin admin admin admin 6. You may change your username and password on the Login Info screen. Once you click "Save," you will be logged out and prompted to log in again with the new credentials. IOTBuddy Web Configuration Guide Page 5 of 24 154-0054-0B Network Configuration 1. Enter the SSID and credentials for the existing Wi-Fi network you wish to connect to the IoTBuddy. 2. You may change your access point password on this page, if desired. 3. If you chose a static IP assignment, please enter it in the "Addressing" section. Enter WIFI Network SSID. Set security options. Set IP Address Type. IOTBuddy Web Configuration Guide Page 6 of 24 154-0054-0B 4. Changing the "Address Assignment" to Static allows for the IP address to be entered. Set IP Address Type. Set IP Address, DNS, Subnet, and Gateway. Select "Save" to Apply Changes. The IP Address to Access the IoTBuddy Will Be the New IP Address. 5. When you hit the "Save" button, you will need to disconnect and reconnect to the access point IOTBxxxxxx. Reconnect, then click the "reload" button on your web browser. 6. For Static Connections: Enter the previously assigned IP address into your browser. You will be prompted with another non-private connection, please proceed. Log in again using your new login credentials. For DHCP Connections: Navigate to the network tab and hit the Copy IP button to copy your new IP address. 1. Press to Copy. 7. You may now connect to your designated Wi-Fi network. Paste the new IP address into your browser. You will be prompted with another non-private connection; please proceed. Log in again using your new login credentials. IOTBuddy Web Configuration Guide Page 7 of 24 154-0054-0B 2. Reconnect to network. 3. Paste Here. Ethernet or Power over Ethernet (POE) Connection Follow installation instructions to wire IoTBuddy to desired Modbus or analog device. 1. For static IP addressing, connect RJ45 Ethernet plug to the IoTBuddy and directly to your computer. Press the button on the IoTBuddy once. Using a web browser, go to https://3.2.1.1. It may take a few seconds before this address is accessible. You may then set up your desired static IP address using the web interface (see steps 4 through 7 found on pages 6 and 7 above). Note: If a static IP address has already been assigned to the IoTBuddy, the currently assigned IP address will need to be used. The designated IP address can be easily retrieved Senva Sync app. For DHCP, connect RJ45 Ethernet plug to IoTBuddy and to your network. Determine your automatically assigned IP address and enter it into your web browser using "https://". Note: The assigned IP address can be easily retrieved Senva Sync app. Your browser may indicate a non-private connection. Click "Advanced" and then "Proceed to xx.xx.x.xxx (unsafe)." Once signed in, you will be able to update security settings to enhance privacy. 2. Your browser may indicate a non-private connection. Click "Advanced" and then "Proceed to xx.xx.x.xxx (unsafe)." IOTBuddy Web Configuration Guide Page 8 of 24 154-0054-0B 3. Log in using the default credentials: · username: admin · password: admin admin admin 4. You may change your username and password on the first screen. Once you click "Save" you will be logged out and prompted to log in again with the new credentials. 5. For static IP addressing, navigate to the "Local Network" tab. Select "Static" address assignment and enter the rest of your credentials in the associated boxes. Once you click "Save" you will be logged out and prompted to log in again, with the new IP address and credentials. IOTBuddy Web Configuration Guide Page 9 of 24 154-0054-0B 1. Select Address Assignment. 2. Set IP 3. Save Configuration. Configuration. Note: The ethernet connection or the power to the IOTBuddy will need to be disconnected then reconnected for the new address to take effect. 6. Once connected, you will see the "Local Network" status icon at the top of the page turn green. IOTBuddy Web Configuration Guide Page 10 of 24 154-0054-0B Cloud Service Setup (Remote Output Connection) 1. Choose your MQTT protocol from AWS IoT Core over MQTT, Azure IoT Hub over MQTT, or plain MQTT. Enter your cloud service or broker information. MQTT connections can be set with Username and Password. Enter here if needed. Enter Broker Address and Client ID Issued by provider. 2. Enter client certificates in the Security section if applicable. MQTT, AWS, and Azure connections can use certificates for authentication. 1. Enable Security. 2. Upload Private Key. 3. Upload Client Certificate. 4. Save Settings. 3. When you hit "save," you should see the Connection Status icon at the top turn green. IOTBuddy Web Configuration Guide Page 11 of 24 154-0054-0B Setting the Modbus Settings for the Connected Device Modbus Settings (Local Device) 1. Navigate to the "Local Device" tab to enter Modbus settings. The Baud Rate, Parity, Stop Bits, and Address fields must match the Modbus device connected to the IoTBuddy. 1. Set Modbus Settings to Match the connected device. 2. Select Save. 2. Navigate to the "Advanced", then" General", then" System Info" tabs to verify Modbus communication. The Modbus RTU TX and Modbus RTU RX values will begin to count when the points are fully defined, and proper communication is established. IOTBuddy Web Configuration Guide Page 12 of 24 154-0054-0B Setting the Data Point Settings for the Connected Device Data Point Settings (Local Modbus Device) 1. Under IoT Connection navigate to "IOT Messages" tab. You may choose one of the pre-configured Senva devices from the dropdown or choose "Basic" to manually enter the points you wish to monitor. 2. Pre-configured points can be selected. 1. Select Device Type. 2. Select Device Points. 3. Select Add. Basic points can be added manually. Preconfigured point properties can also be edited. 1. Add a Basic Point. 2. Select the Point to Open Point Properties. IOTBuddy Web Configuration Guide Page 13 of 24 154-0054-0B 3. Adjust the settings for each point you wish to monitor. The right sidebar provides a detailed description of each field as it is selected. 3. Set Point properties in the boxes above. 4. Save Configuration Data. Data Point Settings (BACnet IP) 3. This section covers the BACnet IP setup. Modbus TCP setup is covered in the next section. Under BAS Connection navigate to the "BAS Setup" tab. You may select the protocol from the drop-down menu. Set each of the BACnet IP Properties and select "Save". The default UDP Port for BACnet IP is 47808. IOTBuddy Web Configuration Guide Page 14 of 24 154-0054-0B This section covers manually adding BACnet IP Points. Loading points from a template is covered in the next section. Under BAS Connection navigate to the "BACnet Objects" tab. Click the "New" button to create a new point. Then select the new point and click the eye icon to open a new window. In the window, set the object Modbus RTU properties, then set the BACnet IP properties. Select "Save" to commit the changes. Select the "Save" Icon to save the BACnet IP Points. 1. Click to add 2. Select Created Object 3. Click the Eye Icon to view Object Properties. 4. Set Point Modbus Properties. 6. Select Save. 5. Set Point BACnet/IP Properties. 7. Select Save. The Currently Saved Points Can be Downloaded as an Object Template File. Selected Points Can be Deleted. IOTBuddy Web Configuration Guide Page 15 of 24 154-0054-0B 5. This section covers loading BACnet IP points from a template. Manually adding BACnet IP Points is covered in the previous section. Under BAS Connection navigate to the "BACnet Objects" tab. Click the "Upload Objects Template" button, then select the file to load and click "Open". This will load a list of points into the "Available Objects" list. Then select the points that you wish to add and select "Add". The Points will be added to the "Added Objects List". Select the "Save" Icon to save the BACnet IP Points. See the previous section for directions on editing BACnet IP point properties, deleting points, and saving a new BACnet IP object template file. 2. Select Template File, Then Open 1. Select to Upload 3. Select Points to Add 4. Select Add to Move to Added Objects List 5. Select Save to Add BACnet IP Objects Added Object File Can be Downloaded as a New Template IOTBuddy Web Configuration Guide Page 16 of 24 154-0054-0B Data Point Settings (Modbus TCP) 5. This section covers the Modbus TCP setup. BACnet IP setup is covered in the previous section. Under BAS Connection navigate to the "BAS Setup" tab. You may the protocol from the drop-down menu. Set each of the Modbus TCP Properties and select "Save". 6. Under BAS Connection navigate to the "Modbus Registers" tab. This screen confirms that Modbus TCP connection is selected and active. The configuration for each point is detailed in the Modbus Setup on page 15 above. IOTBuddy Web Configuration Guide Page 17 of 24 154-0054-0B Analog Settings (Local Device) 1. Navigate to the "Local Device" tab. Select voltage or current from the dropdown and enter the range of the analog signal to be monitored on each channel. Channel A should correspond to your IoTBuddy's white wire and Channel B should be yellow. The Black wire is common/ground for both channels. 1. Select signal type. 2. Set Min and Max Ranges. 3. Scroll Down to set for Channel B. 4. Save Analog Configuration. 2. Navigate to the "IoT Setup" tab. If needed, configure IoT connection (See Data Point Settings- BACnet IP on page 13 or Data Point Settings- Modbus TCP on page 14 ). Then select the "IoT Message Configuration" tab. You may choose one of the pre-configured Senva devices from the dropdown or choose "Basic" to manually enter the points you wish to monitor. Make sure to assign readings to either Channel A or Channel B. 1. Assign Analog Channel. 2. Set Analog Point Properties. 3. Save Analog Configuration. IOTBuddy Web Configuration Guide Page 18 of 24 154-0054-0B 3. Once the points are fully configured, the raw Voltage for Milliamp readings from each channel can be read at the top of the page. The readings update when the page refreshes. Loading Configuration/Firmware files into the IoTBuddy Access and Steps 1. Log in to the IoTBuddy (See the sections on Wi-Fi Connection or Ethernet/POE Connection in the table of contents section for more info). Then select the "Advanced" tab. In the "General" tab there are sections for loading either creating configuration files for download, uploading configuration files or loading firmware files. Select Export to Download the IoTBuddy Current Configuration. Select Choose File to Select the New File to Load for Configuration. Select Choose File in the Firmware Section to Load New Firmware. Select Restart to Remotely Reset the IoTBuddy. This Retains Current Saved Configurations. Loading new configuration or firmware files will overwrite the current IoTBuddy Configuration. IOTBuddy Web Configuration Guide Page 19 of 24 154-0054-0B App Provisioning of the IoTBuddy Setup 2. Open the Senva Sync app available on the Google Play Store for Android or the Apple App Store for iOS. 3. Tap `Scan Device' and place your phone's NFC adapter over IoT Buddy until a successful connection occurs and a green checkmark is displayed. IOTBuddy Web Configuration Guide Page 20 of 24 154-0054-0B 4. The device info will be displayed. Next tap `Edit Settings'. 5. Log in using the IoTBuddy credentials. The defaults credentials are: · username: admin · password: admin 6. Credentials will be Verified. admin admin IOTBuddy Web Configuration Guide Page 21 of 24 154-0054-0B 7. Update available settings as needed. a. For WIFI devices, available settings are: i. Currently assigned IP addresses ii. Login credentials for the IoTBuddy iii. The Settings, Username, and Password for the IoTBuddy Access Point iv. The Settings, Username, and Password for the Local Network WIFI v. IP Addressing Settings, DHCP or Static Ip. b. For ethernet and POE devices, available settings are: i. Currently assigned IP addresses ii. Login credentials for the IoTBuddy iii. IP Addressing Settings, DHCP or Static Ip. 8. After changing the settings as needed, tap `Save'. When prompted to write a device, tap `Single Device'. 9. Place your phone's NFC adapter over IoT Buddy to write the new settings to the IoTBuddy until a successful connection occurs and a green checkmark is displayed. IOTBuddy Web Configuration Guide Page 22 of 24 154-0054-0B IP Address Retrieval using the Sync App 10. Wait at least 5 seconds for IoT Buddy to reboot after a write, then from the app's home page, tap `Scan device'. Place your phone's NFC adapter over IoT Buddy until a successful connection occurs and a green checkmark is displayed. IOTBuddy Web Configuration Guide Page 23 of 24 154-0054-0B 11. The device info will be displayed. Next tap `Edit Settings'. 12. Log in using the IoTBuddy credentials. The defaults credentials are: · username: admin · password: admin 13. Credentials will be Verified. admin admin 14. The currently assigned IP addresses will be displayed at the top under `System Info'. IOTBuddy Web Configuration Guide Page 24 of 24 154-0054-0B