Announcement

Collapse
No announcement yet.

ImperiHome Plug-in - User Guide

Collapse
This topic is closed.
X
This is a sticky topic.
X
X
 
  • Filter
  • Time
  • Show
Clear All
new posts

  • ImperiHome Plug-in - User Guide

    INSTALLATION / CONFIGURATION

    System Requirements:

    This plugin is for HS3 or HS3PRO. It works on both Windows and Linux versions.
    It is designed to interface HomeSeer with ImperiHome mobile apps (Android or iOS). Both Lite and Pro version of the apps are supported.

    Plugin Installation:
    Download and install from the updater (User Interfaces section) or download package from the Beta Testing thread and follow instructions to install.

    Plugin Configuration:
    - Start the plugin from the "PLUG-INS > Manage" page, wait a few seconds for the plugin to initialize
    - go to the config page "PLUG-INS > ImperiHome > Config
    Click image for larger version

Name:	myhs.png
Views:	2
Size:	38.6 KB
ID:	1210637

    By default the plug-in use the HS3 web server which allow to use the MyHS service to connect from an external location. For this to work you need HS3 version 3.0.0.299 or later, and MyHS enabled in Tools > Setup > Network.

    If you tick the "Use custom http server" checkbox, the plugin uses it own web server which by default is started on port 8072. You need to make sure this port is accessible from the Android or iOS devices on which you will install the ImperiHome app, check your firewall. On Windows go to the Windows Firewall Advanced settings and create an inbound rule to allow TCP port 8072 like in the screenshot below:

    Click image for larger version

Name:	inboundrule.png
Views:	1
Size:	43.6 KB
ID:	1209202

    If in the config page you fill the username and password fields, the server will use basic http authentication. This is optional but recommended if you want to use ImperiHome apps from outside of your local network.

    App Installation:
    For Android download and install the Lite or Pro version from the Google's Play Store
    For iOS (iPhone and iPad) download and install from the App Store

    App Configuration:
    Open the app, go to "My Systems", disable the "Demo system", add a new one, and select "Imperihome Standard System" like in the screenshot below:
    Click image for larger version

Name:	config.png
Views:	1
Size:	97.9 KB
ID:	1209014

    In the "Local URL" field enter the URL as it appears in the config page of the plugin, then click Next.
    Last edited by spud; March 3rd, 2017, 11:25 AM.

  • #2
    DEVICES CONFIGURATION

    The plugin automatically scans your HS devices and events and exposes to the ImperiHome app the ones it is able to recognize. The following objects are automatically recognized and sent to ImperiHome:

    • On/Off devices (any HS device that has On/Off "Control Use")
    • Dimmable devices (any HS device that has On/Off and Dim "Control Use")
    • Locks (any HS device that has Door Lock/Door Unlock "Control Use")
    • Thermostats (any group of HS devices that implement the Thermostat API)
    • Events


    Click image for larger version

Name:	devices.png
Views:	3
Size:	98.5 KB
ID:	1183462


    On the left part of the above screenshot, you can see the list view in ImperiHome. Devices are displayed by groups, from the config page of the plugin you can choose the definition of a group: location 1, location 2 or location1 + location2.
    Events appear in ImperiHome as "Scenes" and are grouped by event groups.

    The right part of the screenshot shows a dashboard view. A dashboard view is a customized view in which you choose the layout, you pick the devices you want to see, and you can customize text, colors and icons..

    If one of your On/Off/Dim devices or door Locks do not show up in ImperiHome, make sure the corresponding HS device has the correct ControlUse attributes in the "Status Graphics" tab of the device definition:
    Click image for larger version

Name:	controluse.png
Views:	3
Size:	264.0 KB
ID:	1183463


    Most of other device types can be configured manually from the plugin config page:

    Comment


    • #3
      SECURITY DEVICES

      Security devices are Door/Window sensors, Motion sensors, Smoke sensors, CO2 Alert sensors and Flood sensors. Basically any device that has a binary state (OK/Alarm) can fit into this category.
      To add one, go to the "Security Devices" tab, click the green '+' button, then select the type of sensor and the HS device to be mapped. The Name and Group fields are automatically filled from the name and location attributes of the HS device but can be overridden with anything you want.

      Click image for larger version

Name:	security.png
Views:	1
Size:	34.7 KB
ID:	1183464

      Click image for larger version

Name:	securitydevices.png
Views:	1
Size:	68.6 KB
ID:	1183465

      SENSORS

      A sensor is basically anything that has a numerical value. To add one go to the Sensors tab of the config page, select the type of sensor you want to add, then select the HS device value you want to map it to (some sensors type like the "Temperature and Hygrometry combined sensor" can be mapped to 2 device values). Name and Group fields are automatically populated once you select the first device, but they can be overridden as well as the default units.

      Click image for larger version

Name:	sensors_config.png
Views:	1
Size:	68.7 KB
ID:	1183842

      Click image for larger version

Name:	sensors.png
Views:	3
Size:	126.9 KB
ID:	1183466

      If the Graph checkbox is ticked in the config screen, values for this sensor are recorded every hour, and when you tap the sensor in the ImperiHome app you get a historical data graph.

      Click image for larger version

Name:	Screenshot_2016-03-11-08-51-14.png
Views:	2
Size:	86.1 KB
ID:	1183841

      The "Generic sensor" type can also be used to display a text status rather than a numerical status, in this case the "String Status" checkbox needs to be ticked. See for example the last 3 devices in the screenshot above which are used to display in ImperiHome the current status, track and Artist of a media player.
      Last edited by spud; March 15th, 2016, 11:47 AM.

      Comment


      • #4
        MULTI SWITCHS

        Multi switchs are devices that have multiple choice controls. To add one, go to the "Multi Switchs" tab, click the green '+' button, select the HS device to be mapped as well as the specific controls you want to be available in ImperiHome. The Name and Group fields are automatically populated from the name and location attributes of the HS device but can be overridden with anything you want.

        Note: if the status of the device selected is not both a control and a status, then "N/A" will be shown as the status. This is a problem in ImperiHome that I hope will get fixed soon.

        Click image for larger version

Name:	multiswitchs_config.png
Views:	2
Size:	31.1 KB
ID:	1183468
        Click image for larger version

Name:	music.png
Views:	3
Size:	91.0 KB
ID:	1183469


        CAMERAS

        Camera live feeds can be watched from ImperiHome. To add one camera, go to the "Cameras" tab, click the green '+' button, enter a name for the new camera, then enter a group name and URL parameters. Both JPEG and MJPEG streams are supported, if you want the camera to be accessible from outside of your local network you need to fill at least one of the remote URL.

        Click image for larger version

Name:	cameras.png
Views:	1
Size:	28.5 KB
ID:	1183470

        Note: Alternatively, cameras can be configured directly from ImperiHome by adding a new "IP Camera" system.

        Comment


        • #5
          EVENTS

          By default all events will show up in ImperiHome, but from the events tab you can select/deselect specific events or event groups. If an event group is unselected, none of the events included in this group will show up in ImperiHome, the group itself won't show up, and any new event added to this group won't show up either.
          Even if you can hide those events directly from the ImperiHome settings, it is recommended to do it from the plugin config page so that no useless data is sent to the app, it will make the communication between the plugin and the app faster.

          Click image for larger version

Name:	events.png
Views:	2
Size:	39.1 KB
ID:	1183843
          Last edited by spud; March 15th, 2016, 12:15 PM.

          Comment


          • #6
            CONTROL API

            The Control API is an additional API, only available in the Android app, that let you run the following actions from HS events:
            • Speak: send TTS (Text To Speech) to the app
            • Go To Dashboard Page: make the app go to a specific dashboard page
            • Wake Up: wake up the mobile device on which the app is running.
            • View Camera: make the app directly go to a specific camera page


            To activate it:
            • In your ImperiHome app on your Android device, go to Settings > General Preferences, and tick "Enable API HTTP Server"
            • From the config page, go to the Control API tab, and add a device by clicking the green '+' button and then enter the IP of your Android device. If the plugin is able to reach your Android device the name field will be populated automatically.

            Click image for larger version

Name:	speak_proxy.png
Views:	2
Size:	28.6 KB
ID:	1183846

            then you can create some HS event actions like in the screenshots below:

            Click image for larger version

Name:	speak_action.png
Views:	2
Size:	16.2 KB
ID:	1183844

            Click image for larger version

Name:	gotopage_action.png
Views:	2
Size:	16.2 KB
ID:	1183845

            SPEAK PROXY

            Once the Control API is activated for at least one device, you can make the plugin act as a speak proxy so that any native Speak action can be sent to the ImperiHome app.

            If you already have at least one other plugin acting as a speak proxy, untick "Forward Speak Actions to HS Speakers" to prevent the text to be spoken twice on your other speakers.

            To target a specific ImperiHome device you can edit the list of speakers and add "Imperihome:<name_of_device>" as a speaker

            Click image for larger version

Name:	speak_proxy_target.png
Views:	2
Size:	19.9 KB
ID:	1183847
            Last edited by spud; March 3rd, 2017, 11:34 AM.

            Comment


            • #7
              MULTIPLE INSTANCES

              You may want to run multiple instances of the ImperiHome plug-in. For example if you don't want your kids to have access to all the devices and events, you can create a specific instance for them.

              To do so click the green '+' button from the "PLUG-INS > Manage" page:
              Click image for larger version

Name:	multiinstances.png
Views:	1
Size:	44.3 KB
ID:	1186868

              Enter a name for your instance, submit, and then enable it.
              This will create a new link in the "PLUG-INS > ImperiHome" menu, allowing you to access the configuration screen for this new instance:

              Click image for larger version

Name:	multiinstances2.png
Views:	1
Size:	48.9 KB
ID:	1186869

              Then you will need to choose different port for the http server as both instances can't be run on the same http port. But otherwise the two configurations are independent from each other.

              Comment

              Working...
              X