Difference between revisions of "Network Setup"

From Hubitat Documentation
Jump to: navigation, search
(→‎WiFi Adapter setup)
Line 12: Line 12:
 
#<big>Enter the desired non-routable IP address for your hub to use. The first three octets must match the other devices on your network, but the fourth octet can be any available number on your network. Use the '''Command shell''' tool on Windows (Type '''cmd''' into Windows search), or the '''Terminal''' app on MacOS (Located in the ''Applications'' > ''Utilities'' folder) to ping the IP address you wish to use, ensuring that there is no response from another device on your network before setting your hub to that IP address.</big>[[File:Static IP address entry.jpg|none|thumb|614x614px|link=https://docs.hubitat.com/images/d/d8/Static_IP_address_entry.jpg |alt=On the Networking settings page, enter the desired static IP address and default gateway]]
 
#<big>Enter the desired non-routable IP address for your hub to use. The first three octets must match the other devices on your network, but the fourth octet can be any available number on your network. Use the '''Command shell''' tool on Windows (Type '''cmd''' into Windows search), or the '''Terminal''' app on MacOS (Located in the ''Applications'' > ''Utilities'' folder) to ping the IP address you wish to use, ensuring that there is no response from another device on your network before setting your hub to that IP address.</big>[[File:Static IP address entry.jpg|none|thumb|614x614px|link=https://docs.hubitat.com/images/d/d8/Static_IP_address_entry.jpg |alt=On the Networking settings page, enter the desired static IP address and default gateway]]
 
#<big>Press '''Save and switch to static IP'''. Ensure the first three octets are the same for the '''IP address''' and '''Default gateway''' in accordance with your router IP address settings (i.e. 192.168.0.x).</big>[[File:Static IP values entered.jpg|none|thumb|604x604px|link=https://docs.hubitat.com/images/e/eb/Static_IP_values_entered.jpg |alt=The first three number segments (referred to as octets), must match that of your default gateway. Then enter the gateway IP address just below the IP address field. The gateway IP address you enter must match the gateway IP address of your router. Press the "Save and switch to static IP" button. This button is below the DNS name server field.]]
 
#<big>Press '''Save and switch to static IP'''. Ensure the first three octets are the same for the '''IP address''' and '''Default gateway''' in accordance with your router IP address settings (i.e. 192.168.0.x).</big>[[File:Static IP values entered.jpg|none|thumb|604x604px|link=https://docs.hubitat.com/images/e/eb/Static_IP_values_entered.jpg |alt=The first three number segments (referred to as octets), must match that of your default gateway. Then enter the gateway IP address just below the IP address field. The gateway IP address you enter must match the gateway IP address of your router. Press the "Save and switch to static IP" button. This button is below the DNS name server field.]]
−
#<big>'''You must [https://docs.hubitat.com/Settings reboot] the Hub for the setting to take effect.'''</big>[[File:Reboot after changing static-DHCP.jpg|none|thumb|628x628px|link=https://docs.hubitat.com/images/f/f1/Reboot_after_changing_static-DHCP.jpg |alt=After pressing the "Save and switch to static IP" button, the message "Static IP configured, please reboot" will appear above the "Save and switch to static IP" button. Changes to the IP address of your hub will not take place until you have rebooted the hub. You can access the "Reboot Hub" card from the Settings page of your hub.]]
+
#<big>'''You must [[Settings|reboot]] the Hub for the setting to take effect.'''</big>[[File:Reboot after changing static-DHCP.jpg|none|thumb|628x628px|link=https://docs.hubitat.com/images/f/f1/Reboot_after_changing_static-DHCP.jpg |alt=After pressing the "Save and switch to static IP" button, the message "Static IP configured, please reboot" will appear above the "Save and switch to static IP" button. Changes to the IP address of your hub will not take place until you have rebooted the hub. You can access the "Reboot Hub" card from the Settings page of your hub.]]
  
 
====<big>DCHP address</big>====
 
====<big>DCHP address</big>====
  
−
#<big>To change back to DHCP and let the router assign an IP address to your hub via its MAC Address, press the '''Switch to DHCP now''' button and [https://docs.hubitat.com/Settings reboot] the hub.</big>
+
#<big>To change back to DHCP and let the router assign an IP address to your hub via its MAC Address, press the '''Switch to DHCP now''' button and [[Settings|reboot]] the hub.</big>
−
#*<big>'''NOTE''': Any time you switch between '''Static IP''' and '''DHCP''', you must [https://docs.hubitat.com/Settings reboot] the hub or the setting will not take effect.</big>[[File:Switch back to DHCP.jpg|none|thumb|600x600px|link=https://docs.hubitat.com/images/a/a4/Switch_back_to_DHCP.jpg |alt=To change your hub so it uses an IP address assigned by your router (which is the initial default condition), instead of a Static IP address, press the "Switch to DHCP now" button at the bottom of the Networking page. Changes to the IP address of your hub will not take place until you have rebooted the hub. You can access the "Reboot Hub" card from the Settings page of your hub.]]
+
#*<big>'''NOTE''': Any time you switch between '''Static IP''' and '''DHCP''', you must [[Settings|reboot]] the hub or the setting will not take effect.</big>[[File:Switch back to DHCP.jpg|none|thumb|600x600px|link=https://docs.hubitat.com/images/a/a4/Switch_back_to_DHCP.jpg |alt=To change your hub so it uses an IP address assigned by your router (which is the initial default condition), instead of a Static IP address, press the "Switch to DHCP now" button at the bottom of the Networking page. Changes to the IP address of your hub will not take place until you have rebooted the hub. You can access the "Reboot Hub" card from the Settings page of your hub.]]
 
#<big>If you are accidentally blocked from accessing your hub due to an incorrect or unknown IP address setting, turn the hub over and use the point of a pen to press the small button just beneath the surface of the hub casing for at least '''7 seconds'''.</big>[[File:Hub DHCP reset button.png|none|thumb|254x254px|link=https://docs.hubitat.com/images/1/16/Hub_DHCP_reset_button.png |alt=If you are accidentally blocked from accessing your hub due to an incorrect or unknown IP address setting, turn the hub over and use the point of a pen to press a small button just beneath the surface of the hub casing for at least 7 seconds. All of the holes on the bottom of the hub are square in shape, but one hole is round. With the hub upside-down and the Ethernet port at the top, the round hole will be in the top row, sixth from the right.]]
 
#<big>If you are accidentally blocked from accessing your hub due to an incorrect or unknown IP address setting, turn the hub over and use the point of a pen to press the small button just beneath the surface of the hub casing for at least '''7 seconds'''.</big>[[File:Hub DHCP reset button.png|none|thumb|254x254px|link=https://docs.hubitat.com/images/1/16/Hub_DHCP_reset_button.png |alt=If you are accidentally blocked from accessing your hub due to an incorrect or unknown IP address setting, turn the hub over and use the point of a pen to press a small button just beneath the surface of the hub casing for at least 7 seconds. All of the holes on the bottom of the hub are square in shape, but one hole is round. With the hub upside-down and the Ethernet port at the top, the round hole will be in the top row, sixth from the right.]]
 
#*
 
#*
Line 27: Line 27:
 
#*<big>'''NOTE:''' No additional drivers are required for cellular adapters.</big>
 
#*<big>'''NOTE:''' No additional drivers are required for cellular adapters.</big>
 
#*<big>Wait for the confirmation, '''Cellular adapter support added''' before plugging in the adapter.</big>[[File:Add Cellular adapter support v3.png|none|thumb|600x600px|link=https://docs.hubitat.com/images/5/5b/Add_Cellular_adapter_support_v3.png |alt=With the required OTG + power adapter cable attached, press the "Add adapter support" button located midway on the left of the Networking page. No additional drivers are required for cellular adapters. Once the button has been pressed, attached the cellular adapter to the female USB type "A" port of the OTG + power adapter cable. You must reboot your hub before the adapter will be active. You can access the "Reboot Hub" card from the Settings page of your hub.]]
 
#*<big>Wait for the confirmation, '''Cellular adapter support added''' before plugging in the adapter.</big>[[File:Add Cellular adapter support v3.png|none|thumb|600x600px|link=https://docs.hubitat.com/images/5/5b/Add_Cellular_adapter_support_v3.png |alt=With the required OTG + power adapter cable attached, press the "Add adapter support" button located midway on the left of the Networking page. No additional drivers are required for cellular adapters. Once the button has been pressed, attached the cellular adapter to the female USB type "A" port of the OTG + power adapter cable. You must reboot your hub before the adapter will be active. You can access the "Reboot Hub" card from the Settings page of your hub.]]
−
#<big>Plug in the cellular adapter and '''[https://docs.hubitat.com/Settings reboot]''' the hub.</big>
+
#<big>Plug in the cellular adapter and '''[[Settings|reboot]]''' the hub.</big>
−
#*<big>'''NOTE:''' You must '''[https://docs.hubitat.com/Settings reboot]''' the hub before the cellular adapter will allow Remote Admin to access the hub over a cellular network.</big>
+
#*<big>'''NOTE:''' You must '''[[Settings|reboot]]''' the hub before the cellular adapter will allow Remote Admin to access the hub over a cellular network.</big>
−
#*<big>The USB cellular modem is intended to be used with a [https://docs.hubitat.com/Remote_Admin Remote Admin] subscription to manage a hub in a remote location without WiFi.</big>[[File:Cellular adapter support added v2.png|none|thumb|600x600px|link=https://docs.hubitat.com/images/b/bd/Cellular_adapter_support_added_v2.png ]]
+
#*<big>The USB cellular modem is intended to be used with a [[Remote Admin]] subscription to manage a hub in a remote location without WiFi.</big>[[File:Cellular adapter support added v2.png|none|thumb|600x600px|link=https://docs.hubitat.com/images/b/bd/Cellular_adapter_support_added_v2.png ]]
  
 
===<big>WiFi Adapter setup</big>===
 
===<big>WiFi Adapter setup</big>===
Line 37: Line 37:
 
#<big>Enter the network name (SSID) of the WiFi network you want your hub to join and then enter the WiFi password.</big>
 
#<big>Enter the network name (SSID) of the WiFi network you want your hub to join and then enter the WiFi password.</big>
 
#<big>Press the '''Save WiFi configuration''' button</big>
 
#<big>Press the '''Save WiFi configuration''' button</big>
−
#<big>Plug the WiFi adapter to the OTG + power adapter cable and</big> '''<big>[https://docs.hubitat.com/Settings reboot]</big>''' <big>the hub.</big>
+
#<big>Plug the WiFi adapter to the OTG + power adapter cable and</big> '''<big>[[Settings|reboot]]</big>''' <big>the hub.</big>
−
#*<big>'''NOTE:''' You must '''[https://docs.hubitat.com/Settings reboot]''' the hub to activate your WiFi adapter and connect it to your WiFi network.</big>[[File:Enter WiFi username and password.jpg|none|thumb|644x644px|link=https://docs.hubitat.com/images/0/0f/Enter_WiFi_username_and_password.jpg |alt=The WiFi connection section of the Networking page has fields for the WiFi network name (commonly referred to as the SSID), and a field to enter your WiFi password below the "WiFi network name" field. After entering the WiFi network name and password for the wireless network that you want your hub to join, press the "Save WiFi configuration" button. You should reboot your hub to ensure it is able to connect to your local wireless network. You can access the "Reboot Hub" card from the Settings page of your hub.]]
+
#*<big>'''NOTE:''' You must '''[[Settings|reboot]]''' the hub to activate your WiFi adapter and connect it to your WiFi network.</big>[[File:Enter WiFi username and password.jpg|none|thumb|644x644px|link=https://docs.hubitat.com/images/0/0f/Enter_WiFi_username_and_password.jpg |alt=The WiFi connection section of the Networking page has fields for the WiFi network name (commonly referred to as the SSID), and a field to enter your WiFi password below the "WiFi network name" field. After entering the WiFi network name and password for the wireless network that you want your hub to join, press the "Save WiFi configuration" button. You should reboot your hub to ensure it is able to connect to your local wireless network. You can access the "Reboot Hub" card from the Settings page of your hub.]]
  
 
<big>'''<span style="color: red;;">IMPORTANT !</span>'''</big>
 
<big>'''<span style="color: red;;">IMPORTANT !</span>'''</big>
  
−
*<big>You must [https://docs.hubitat.com/Settings reboot] the hub or the setting will not take effect.</big>
+
*<big>You must [[Settings|reboot]] the hub or the setting will not take effect.</big>
 
*<big>WiFi dongles are '''not included''' with Hubitat Elevation. For maximum reliability, connect the hub to your network with an Ethernet cable whenever possible.</big>
 
*<big>WiFi dongles are '''not included''' with Hubitat Elevation. For maximum reliability, connect the hub to your network with an Ethernet cable whenever possible.</big>
 
*<big>'''Static IP/DHCP''' configuration is for use with the built in Ethernet port only. '''WiFi USB adapters always use DHCP'''.</big>
 
*<big>'''Static IP/DHCP''' configuration is for use with the built in Ethernet port only. '''WiFi USB adapters always use DHCP'''.</big>
Line 50: Line 50:
 
<big>If you have configured a WiFi adapter and want to restore hub connection via Ethernet, do not simply pull the WiFi adapter from your hub.</big>
 
<big>If you have configured a WiFi adapter and want to restore hub connection via Ethernet, do not simply pull the WiFi adapter from your hub.</big>
  
−
#<big>'''[https://docs.hubitat.com/Settings Shutdown]''' the hub.</big>
+
#<big>'''[[Settings|Shutdown]]''' the hub.</big>
 
#<big>Disconnect your WiFi adapter (and the special OTG + power cable if desired).</big>
 
#<big>Disconnect your WiFi adapter (and the special OTG + power cable if desired).</big>
 
#<big>Plug in an Ethernet cable, connecting the hub to your router or network switch.</big>
 
#<big>Plug in an Ethernet cable, connecting the hub to your router or network switch.</big>

Revision as of 21:21, 10 May 2021

Go to the top of the page

The Networking settings allow you to switch between DHCP (Dynamic Host Configuration Protocol) for automatic setting of your hub IP address, or Static IP where you can define the IP address for your hub when connected by Ethernet cable. You can also add a compatible WiFi dongle to allow your hub to join a WiFi network without the need to attach an Ethernet cable.

NOTE:

  • WiFi dongles are not included with Hubitat Elevation. For maximum reliability, connect Hubitat Elevation to your network with an Ethernet cable whenever possible.
  • Static IP/DHCP configuration is for use with the built-in Ethernet port only. WiFi USB adapters will always use DHCP.
  • Setting a Static IP address and configuring a WiFi USB adapter is not available for hubs prior to Model C-5.

Static IP/DHCP configuration

Static IP address

  1. Enter the desired non-routable IP address for your hub to use. The first three octets must match the other devices on your network, but the fourth octet can be any available number on your network. Use the Command shell tool on Windows (Type cmd into Windows search), or the Terminal app on MacOS (Located in the Applications > Utilities folder) to ping the IP address you wish to use, ensuring that there is no response from another device on your network before setting your hub to that IP address.
    On the Networking settings page, enter the desired static IP address and default gateway
  2. Press Save and switch to static IP. Ensure the first three octets are the same for the IP address and Default gateway in accordance with your router IP address settings (i.e. 192.168.0.x).
    The first three number segments (referred to as octets), must match that of your default gateway. Then enter the gateway IP address just below the IP address field. The gateway IP address you enter must match the gateway IP address of your router. Press the "Save and switch to static IP" button. This button is below the DNS name server field.
  3. You must reboot the Hub for the setting to take effect.
    After pressing the "Save and switch to static IP" button, the message "Static IP configured, please reboot" will appear above the "Save and switch to static IP" button. Changes to the IP address of your hub will not take place until you have rebooted the hub. You can access the "Reboot Hub" card from the Settings page of your hub.

DCHP address

  1. To change back to DHCP and let the router assign an IP address to your hub via its MAC Address, press the Switch to DHCP now button and reboot the hub.
    • NOTE: Any time you switch between Static IP and DHCP, you must reboot the hub or the setting will not take effect.
      To change your hub so it uses an IP address assigned by your router (which is the initial default condition), instead of a Static IP address, press the "Switch to DHCP now" button at the bottom of the Networking page. Changes to the IP address of your hub will not take place until you have rebooted the hub. You can access the "Reboot Hub" card from the Settings page of your hub.
  2. If you are accidentally blocked from accessing your hub due to an incorrect or unknown IP address setting, turn the hub over and use the point of a pen to press the small button just beneath the surface of the hub casing for at least 7 seconds.
    If you are accidentally blocked from accessing your hub due to an incorrect or unknown IP address setting, turn the hub over and use the point of a pen to press a small button just beneath the surface of the hub casing for at least 7 seconds. All of the holes on the bottom of the hub are square in shape, but one hole is round. With the hub upside-down and the Ethernet port at the top, the round hole will be in the top row, sixth from the right.

Cellular Adapter setup

  1. Connecting a USB device to your Hubitat hub requires a special OTG + power cable. This type of adapter cable feeds power to the hub while simultaneously providing a USB data connection for USB devices.
    Connecting a USB device to your Hubbitat hub requires a special OTG + power cable. This type of adapter cable feeds power to the hub while simultaneously providing a USB data connection for USB type "A" devices. This cable has a single connector with a female USB type "A" port (which is the typical rectangular shaped USB connection) at one end, with a split of two different micro connectors at the other ends. One side of the split will have a male micro USB connector, while the other side of the split will have a female micro USB connector
  2. Press the Add adapter support button to install support for the cellular adapter.
    • NOTE: No additional drivers are required for cellular adapters.
    • Wait for the confirmation, Cellular adapter support added before plugging in the adapter.
      With the required OTG + power adapter cable attached, press the "Add adapter support" button located midway on the left of the Networking page. No additional drivers are required for cellular adapters. Once the button has been pressed, attached the cellular adapter to the female USB type "A" port of the OTG + power adapter cable. You must reboot your hub before the adapter will be active. You can access the "Reboot Hub" card from the Settings page of your hub.
  3. Plug in the cellular adapter and reboot the hub.
    • NOTE: You must reboot the hub before the cellular adapter will allow Remote Admin to access the hub over a cellular network.
    • The USB cellular modem is intended to be used with a Remote Admin subscription to manage a hub in a remote location without WiFi.
      Cellular adapter support added v2.png

WiFi Adapter setup

  1. Follow these instructions to add a compatible WiFi adapter to your hub. Connecting a USB device to your Hubitat hub requires a special OTG + power cable. This type of adapter cable feeds power to the hub while simultaneously providing a USB data connection for USB devices.
    OTG + power cable.png
  2. Press the Install WiFI driver button and ensure the installation succeeded before continuing.
    With the required OTG + power adapter cable attached, press the "Install WiFi drivers" button located in the "WiFi Drivers" section of the Networking page, just above the "WiFi connection fields. Once the button has been pressed, attached a supported WiFi adapter to the female USB type "A" port of the OTG + power adapter cable. You must reboot your hub before the adapter will be active. You can access the "Reboot Hub" card from the Settings page of your hub.
  3. Enter the network name (SSID) of the WiFi network you want your hub to join and then enter the WiFi password.
  4. Press the Save WiFi configuration button
  5. Plug the WiFi adapter to the OTG + power adapter cable and reboot the hub.
    • NOTE: You must reboot the hub to activate your WiFi adapter and connect it to your WiFi network.
      The WiFi connection section of the Networking page has fields for the WiFi network name (commonly referred to as the SSID), and a field to enter your WiFi password below the "WiFi network name" field. After entering the WiFi network name and password for the wireless network that you want your hub to join, press the "Save WiFi configuration" button. You should reboot your hub to ensure it is able to connect to your local wireless network. You can access the "Reboot Hub" card from the Settings page of your hub.

IMPORTANT !

  • You must reboot the hub or the setting will not take effect.
  • WiFi dongles are not included with Hubitat Elevation. For maximum reliability, connect the hub to your network with an Ethernet cable whenever possible.
  • Static IP/DHCP configuration is for use with the built in Ethernet port only. WiFi USB adapters always use DHCP.
  • WiFi USB adapter configuration is not available for hubs prior to Model C-5.

Changing connection from WiFi to Ethernet

If you have configured a WiFi adapter and want to restore hub connection via Ethernet, do not simply pull the WiFi adapter from your hub.

  1. Shutdown the hub.
  2. Disconnect your WiFi adapter (and the special OTG + power cable if desired).
  3. Plug in an Ethernet cable, connecting the hub to your router or network switch.
  4. Unplug your hub from its power source for a minimum of 30 seconds before plugging it back in.
    • NOTE: To avoid stressing the micro USB connection, it is recommended that power be removed from the hub by unplugging the power adapter from the outlet instead of the hub.
Retrieved from "https://docs.hubitat.com/index.php?title=Network_Setup&oldid=5041"