View source for Polisy:User Guide

Welcome to our Polisy corner: your one place for anything Polisy! 

='''First Steps'''=
==Requirements==
* Make sure your ISY is on 5.0.16+
* Make sure your network has DHCP enabled
* Make sure your ISY has either the ISY Portal or the Network Module (Polisy comes with two years of ISY Portal free of charge)
===Requesting for ISY Portal Extension===
* If you have never had ISY Portal installed on your ISY, please go to [https://my.isy.io ISY Portal], register for a 30 day trial, then send your UUID and a copy of your Polisy invoice to [mailto://sales@universal-devices.com&subject=Polisy%20ISY%20Portal%20Extension  sales@Universal-devices.com]
* If you already have ISY Portal installed, please send your UUID and a copy of your Polisy invoice to [mailto://sales@universal-devices.com&subject=Polisy%20ISY%20Portal%20Extension  sales@Universal-devices.com]

==Installation==
Installation is quite easy
* Connect one of the included Cat5e cable to Polisy’s Network Port and to your network hub. You must use the port that’s closest to the right most edge of Polisy when the front of Polisy is facing you (closest to the db-9 serial port). '''Note''': the network must initially be DHCP enabled
* If you have the PRO version, attach the included antennas to the back of the unit
* Connect the power supply
'''Note''': once Polisy is up and running, it will automatically look for your ISY on the network. As such, it's best to make sure your Polisy and your ISY are on the same network.

===First Ever Bootup Sequence===
If this is Polisy's first bootup, please be patient as polisy will go through an initial sequence of lights and sounds while it prepares itself for you. This process might take up to 2 minutes:
* All three lights on the front light up when powered on
* After a few seconds, only the left most stays lit for up to a minute
* All three lights start blinking and a beeping sequence starts
* The beeping stops within 25 seconds. If beeping does not stop, make sure the network cable is connected to the correct jack on Polisy and that your network is DHCP enabled
* Everything is operational once only the left most light is lit

===Normal Bootup Sequence===
* All three lights on the front light up when powered on
* After a few seconds, only the left most stays lit for up to a minute
* All three lights start blinking and a beeping sequence starts which lasts about 5 seconds
* Everything is operational once only the left most light is lit

==Accessing Polisy==
If you have a modern router, Polisy advertises itself as '''polisy''' on your network. As such, and in most cases, simply open your browser to [https://polisy https://polisy]. 
You will be prompted with a security warning by your browser because polisy uses a self-signed certificate. Please ignore the warning.

[[File:Notsecure.png]]

You are then presented with the login screen. The default username is '''admin''' and default password is '''admin'''. Please make sure you change your default username/password once you login.

[[File:Login button.png]]


[[File:Login dialog.png]]

And that's it! And, since we are always improving Polisy, the first thing you should do is to check for updates (it's always good to reboot after each update):

[[File:Pcheckforupdate.png]]

==Troubleshooting==
===Can't Find Polisy===
If you are having a hard time finding your Polisy using https://polisy, it's best to check your router's DHCP client list and look for a device that has the same MAC address as the one the label at the bottom of your Polisy. Polisy's MAC address starts with '''00:0d:b9'''. 

[[File:Dhclientlist.png]]


===Polisy Keeps Beeping===
====Networking Issue====
* Make sure you have connected the network cable to the '''right''' jack on the back of the unit (the right most when Polisy is facing you)
* Make sure the unit has Internet connectivity since, in some cases, it must download the latest packages upon first installation
* Make sure your ISY is running firmware 5.0.16+ and is on the same network as Polisy 

====Latest Packages Not Installed====
If the above does not work, you will need an ssh utility (such as putty) to connect to Polisy over the network:
1. ssh admin@polisy (you can change polisy to the IP address of your unit)
2. Default password is admin. Once this process is done, please change it
3. Run the following commands:
* sudo service polyglot stop
* sudo service udx stop
* sudo pkg update
* sudo pkg upgrade
* sudo service polyglot start
* sudo service udx start

====Corrupted Database====
* ssh admin@polisy (you can change polisy to the IP address of your unit)
* Default password is admin. Once this process is done, please change it
* Run the following commands
sudo service mongod status. If it's not running, then:
* sudo rm -rf /var/db/mongodb 
* sudo reboot

='''Some Definitions!'''=
==Node Servers==
As you might already know, in ISY, everything is represented as a Node. These are things (or devices) that show up in your left navigation bar under ISY. A long time ago, these nodes were limited to INSTEON,X10/A10, Z-Wave, and Zigbee. Basically protocols for which ISY had native support. We designed and developed node servers so that developers could integrate their things into ISY as nodes. And, hence, Node Servers: they serve nodes to ISY. 

These nodes can be anything. They can be representing real devices in the world such as Ring, Tesla, WiFi light bulbs, Ecobee .. or they could be completely virtual such as calendars and climate services. Once a node is represented in ISY, then the whole ISY event based and programming environment are available to it. In short, Node Servers allow ISY to support pretty much any device or thing out there.

[[File::Nodes.png]]

But, where do these node servers live? Well, you have come this far, so read on ...

==Polyglot==
Node servers have to run on some computing device. And, forcing each developer to have to come up with his/her own node server from scratch would be completely detrimental to our quest. So, we designed and developed Polyglot which is a framework that allows developers to develop their node servers with ease and confidence that all the plumbing/security and communications with ISY is handled automatically.

And, of course, being geeks ourselves, we developed Polyglot to run on geeky things such as Raspberry Pi. If you are a geek and at home with ssh, ifconfig, pip, npm, and Linux system admin you will be right at home installing Polyglot on a Raspberry Pi and enjoying it. 

And, here comes the punchline for those who are not geeks: 

==Polisy==
Polisy is our own shiny, beautiful, powerful hardware/OS preconfigured and optimized to run Polyglot (and other things). So, for those of you non-geeks out there, we have taken all the geekiness out of Polyglot and provided you with a ready to run box. So, now that we got you excited, let's continue with setting up and using your Polisy.

[[File:All new polisy-ANT.jpg | 600px | center]]


='''Polisy Dashboard'''=

Once you have successfully logged into Polisy, you will get the Polisy Dashboard which is designed to be simple and functional. If your ISY is on the same network, Polisy will try to find it and login to it using default username/password (1 in the picture below). If ISY is not found, don't despair! You can configure Polisy with [[#ISY Settings | ISY's connection parameters]]. 

If this is the first time you have logged into Polisy, and if you have the ISY Portal module, you might see ISY Portal listed as a node server. You can ignore this node server since it's not managed by Polisy.


[[File:Pdashboard.png]]


==NodeServers Menu==
[[File:Nsmenu.png|Right]]

===NodeServer Store===
This is where all the available node servers are listed. In order to install one of these node servers into ISY, first, click on the Install button to import the node server into Polisy. Once the node server is installed into Polisy, the next step is to install it into ISY using '''Add NodeServer''' menu option.

[[File:Nstore.png|500px|center]]

===Add NodeServer===
Use this menu option to install the NodeServer that you have imported into Polisy into ISY. 

[[File:Adns.png|500px|center]]

==Settings Menu==
[[File:Psettings.png|Right]]

Setting menu allows you to configure Polyglot and System settings. 

===Polisy Configuration===

Allows you to configure system wide time zone and network settings:

[[File:Pnet.png|center|500px]]

To change the Time Zone, you must click on the '''Change''' button!

You can also configure your WiFi if you have Polisy PRO.

[[File:Pwifi.png|center|500px]]

===Polyglot Configuration===

If you are not a geek, the only options in this page that are of importance are:

====Backup and Restore Polyglot====

Yes, you can! If you have been running Polyglot on Raspberry Pi or something else, you can simply back it up and then restore it onto Polisy using these two self explanatory buttons.

[[File:Backuprestore.png|center]]



====ISY Settings====
If Polisy has not been able to find and commission your ISY, update this section with ISY parameters such as IP, username, and password.

[[File:isysettings.png|center]]

==System Menu==
Use this menu to keep your Polisy, Polyglot, and ISY in tiptop shape!

[[File:Psystem.png]]

===Restart Polyglot ===
Restarts the Polyglot instance running inside Polisy. 

===Reboot ISY===
Self explanatory.

===Check for Polisy Updates===
Use this menu regularly to make sure your Polisy is up to date.

===Update Polisy===
Use this menu if you want to update your Polisy with the latest and greatest as reported by the previous menu.

===Reboot Polisy===
Reboots the whole system.

===Shutdown Polisy===
Shutdown the whole system.

=Multi Function Button=
[[File:Multifunction.png|right]] 

There's a little multi function button behind the very small hole on the front of the unit. 
This button has multiple purposes outlined below. Every click on the button will cause the unit to beep.

If the button does not behave as described below, please [[Polisy:User_Guide#Update_Polisy | update Polisy]].

==Update and Upgrade All the Packages==
Click the button '''once'''.

==Safely Reboot==
Click the button '''twice'''.

==Safely Shutdown==
Click the button '''three times'''.

==Reset Credentials==
Press and hold the button till the '''first''' LED (from the left) starts blinking then release. This action resets Polyglot as well as SSH credentials back to the default admin/admin.

==Reset Networking==
Press and hold the button till the '''first and second''' LEDs (from the left) start blinking then release. This action resets all network configuration back to DHCP on the Ethernet jack next to the serial port. All other network interfaces shall be disabled.

==Factory Reset==
Press and hold the button till '''all''' LEDs start blinking then release. This action resets the credentials, removes all configurations from Polyglot/Polisy, and resets networking.

=Debugging=
==Getting Into Polisy Using Serial Port ==
[https://forum.universal-devices.com/topic/28645-polisy-hw-how-to-serial-console/?tab=comments#comment-280576 Connect to Polisy]