Note: Before you can point a gateway to your custom host or IP address, you need to unlock the gateway if this has not already been purchased. Gateway Unlock codes can be purchased here. If your gateway is not already Unlocked, it will need to communicate with the iMonnit Online portal through the Internet on outbound port 3000 to receive the Unlock command.
Unlocking and pointing supported gateways:
Monnit calls the interface through which data is transmitted to Monnit software the Default Interface. Monnit Ethernet Gateway 4, Ethernet Gateway 3, 4G LTE Gateway, 3G Cellular Gateway, and 2G Cellular Gateway are supported by the SetHost tool (USB Gateways and Wireless Sensor Adapters may display an error, and a request to Unlock them along with an Unlock Code should be sent to firstname.lastname@example.org. This tool will allow you to Unlock and Point the gateway to a local Enterprise, Express, or MINE server (gateways can transmit data to only a single destination at a time using the Default Interface). Once you have the gateway in-hand, and have received an Unlock Code, you can follow the steps below to Unlock and Point your gateway to your local server.
Summary of Steps
(You must be signed into your iMonnit Online account in order to view the imonnit.com/SetHost site, otherwise you might see a 404 error.)
- Apply the Unlock Code to the gateway.
- Using the SetHost tool, set the host address and for the server that will be receiving data from the gateway, and static IP address if necessary.
- Connect the gateway to the iMonnit Online portal.
- Confirm the gateway checks in with the iMonnit Online portal to receive the Unlock/Point commands.
- Confirm that your gateway communicates with the new host.
- Resetting the device to communicate with the iMonnit Online portal.
Apply the Unlock Code to the gateway
When an Unlock Code is purchased, an email with the code is delivered to the email address on the order. This code will need to be copied and entered into the SetHost tool, along with the Gateway’s ID and Security Code to initiate the Unlock process. This can be done by following the steps below.
- Visit the https://www.imonnit.com/SetHost site.
- Enter the Gateway’s ID and Security Code found on the gateway’s physical label.
- Click the Gateway Server Settings button.
- Copy the Unlock Code text from the email and paste it into the Unlock Code field.
- Click the Submit Query button.
Using the SetHost tool, set the host address and for the server that will be receiving data from the gateway, and static IP address if necessary
At this point, the gateway Unlock Code is pending receipt by the gateway. This will occur upon the gateway’s subsequent check in with iMonnit Online. If you wish to also Point the gateway to the local server, follow the steps below.
Note: If you are using a cellular gateway, the domain or IP address must be a public facing address accessible through the Internet.
- Enter the domain or IP address of the server hosting the iMonnit software in the Enterprise/Express Host Address field.
- If your gateway requires a static IP, you can disable DHCP by clicking the DHCP button and enter a static IP (all four IP configurations are required).
- Click the Save button.
Connect the gateway to the iMonnit Online portal
The Unlock and Point commands will be pending at this point. In order for the gateway to receive the commands, the gateway will need to check in with the iMonnit Online portal. This means you will need to connect the gateway to a network that will support communication from the device to the Internet on port 3000. Once this has been accommodated, the gateway will check in with the iMonnit Online portal, receive the Unlock Command, and be pointed to the new host address. If you configured a Static IP address, it will be applied to the gateway at this point (which is important to consider if you are moving the gateway to operate on a different network).
Confirm that your gateway communicates with the new host
There will be some configuration that will be required to allow for your gateway to communicate with the new server host. You will need to register the gateway with the server so it is authorized to send data to the server. The process of adding the gateway to the server will vary depending on the type of Monnit software to which you are pointing the gateway. You can consult the resources for that product for information on adding the gateway. But if the gateway is added to the server host, receives the Unlock/Point commands, and has a valid network path by which it can reach the server, it will communicate with the new server host.
A useful tool which can be run on a Windows PC to determine if your Enterprise server is prepared to accept communication from the gateway can be found at the following link. If your gateway has been added to your network in iMonnit Enterprise, you can launch this tool to confirm your Enterprise server is configured to receive communication from the gateway. This can be done with the following steps.
- Enter the ID of your gateway
- Select the gateway type
- Uncheck the Use Defaults option
- Enter the Enterprise server’s IP address for Server Address
- Click the Check Communication button.
The tool will attempt to resolve DNS and send a pseudo-check-in from your gateway to your server. If the test is successful, there is no issue with DNS or TCP port 3000 being open on that network segment for the PC, and the server is configured to receive communication from the gateway. This tool can be run from the Enterprise server itself, or it could be run from another computer if you are analyzing network operation. If the tool fails, you will want to confirm that the Enterprise Wireless Gateway Server is running in the Windows Services program, and the gateway has been added to a network in the Enterprise portal.
Resetting the device to communicate with the iMonnit Online portal
After your gateway has been pointed to a new server host, there may be a scenario in which you need to point the gateway back to the iMonnit Online portal. There are two steps that will need to be taken to do this.
First, you will need to prepare the iMonnit Online portal to receive communication from the gateway again. If this is not done, the gateway will attempt to communicate with iMonnit Online repeatedly, and be turned away repeatedly. This can be done by visiting the imonnit.com/SetHost site, entering the Gateway ID and Security Code, and clicking the Reset Defaults button. Once that button is clicked, the gateway will no longer be flagged in the iMonnit Online software to turn away communication from the gateway.
Second, you will need to reset the gateway’s server/host configuration. Most gateways can be reset to default settings by pressing and holding the Reset/Utility button for 15-20 seconds, then releasing. Cellular gateways can receive host configurations via SMS. USB Gateways can be pointed back to iMonnit Online using the Monnit Link Gateway Utility. Whichever gateway type/method is used, the gateway will subsequently be able to communicate with the iMonnit Online portal again.
Unlocking USB Gateways/Wireless Sensor Adapters
As mentioned above, the SetHost tool does not support USB Gateways/Wireless Sensor Adapters. Therefore these devices need to be Unlocked manually by Monnit Support. To do this, simply send an email to email@example.com with the gateway ID and the Unlock Code, and the gateway will be Unlocked. It is important to know that USB Gateways/Wireless Sensor Adapters store the Unlock status in a file on the computer from which it is Unlocked. Therefore if you move a USB Gateway/Wireless Sensor Adapter from one computer where it was Unlocked to another computer, the Unlock status will no longer be in effect. You will need to send another request to have the gateway Unlocked.
To determine if your USB Gateway has been successfully Unlocked, launch the Monnit Link Gateway Configuration Utility, click the Actions menu in the Menu Bar, and look for the option Configure Server Location. If you see it, your gateway has been successfully Unlocked on this computer. If you do not see this option, the gateway will need to be Unlocked by Monnit Support.
When operating with iMonnit Enterprise, iMonnit Express, or Monnit MINE, the gateway will need to be pointed to the new host. The steps in this article should allow you to do this. If there are unexpected results, feel free to contact Monnit Support for feedback.