demo home portal server user guide 20150207

37
Feb 07 th , 2015

Upload: others

Post on 19-Jan-2022

5 views

Category:

Documents


0 download

TRANSCRIPT

Page 1: Demo Home Portal Server User Guide 20150207

Feb 07th, 2015

Page 2: Demo Home Portal Server User Guide 20150207

Table of Contents

1. Introduction _________________________________________________________ 1

1.1. System Requirements ____________________________________________________ 1

1.2. Accessing Home Portal Server _____________________________________________ 2

1.3. XMPP Setting For the Security Panels _______________________________________ 3

2. Registration _________________________________________________________ 5

3. Operation __________________________________________________________ 10

2.1. Log In ______________________________________________________________ 10

2.2. Security _____________________________________________________________ 12

2.2.1. System Area ________________________________________________________ 13

2.2.1. System Mode ________________________________________________________ 13

2.2.2. Sensors ____________________________________________________________ 15

2.2.3. IP Cam List __________________________________________________________ 15

2.3. Automation __________________________________________________________ 16

2.3.1. Device______________________________________________________________ 16

2.3.2. Group ______________________________________________________________ 18

2.3.3. Scene ______________________________________________________________ 19

2.4. IP Camera ___________________________________________________________ 23

2.5. Event _______________________________________________________________ 24

2.6. Setting ______________________________________________________________ 25

2.6.1. Device______________________________________________________________ 25

2.6.2. Panel_______________________________________________________________ 29

2.6.3. Report ______________________________________________________________ 31

2.7. Account _____________________________________________________________ 34

Page 3: Demo Home Portal Server User Guide 20150207

1

1. Introduction

Home Portal™ Sever is a smart home platform, delivering smart home services for end-users to control home devices and security remotely via PC or smart phones over internet. Home portal™ server enables users to connect to a home gateway to enjoy convenient services that include security control, alarm event reporting, home automation, energy management, and video verification.

Home Portal™ Server provides a good platform to integrate all services and makes life easier for all users. With Home Portal™ software choices also available on iPhone™, iPad™ and Android mobile devices, you can directly monitor and control your home status wherever you go!

This User Guide will guide you through the process of Home Portal™ Server registration and operation. After registering your control panel, you will be able to utilize Home Portal™ Server’s functions that include: System status and setting control, device learning and management, security event history, image viewing and report setting.

1.1. System Requirements

- Microsoft Windows 98, ME, NT4.0, 2000, XP, 7, or 8 operating systems.

- Microsoft Internet Explorer 5.x, or later and Mozilla Firefox 1.0 compatible.

- CPU: Intel Pentium II 266MHz or above

- Memory: 32MB (64MB recommended)

- VGA resolution: 800x600 or above

Page 4: Demo Home Portal Server User Guide 20150207

2

1.2. Accessing Home Portal Server

Home Portal Server can be accessed through web access through your computer’s internet browser, or application on a mobile device (smartphone or tablet computer). Both the internet browser and application have the same user interface and function.

Website Access

Open your internet browser and enter https://homeportal.climax.com.tw/ to access the Home Portal Server webpage..

App Access

The smartphone application are available for both Android and iOS smartphone and tablet. Please go to APP store or Google Play and search Vesta Home 2 to for the home portal application.

The system requirement for Android device is Android 4.0.

The system requirement for iOS device is iOS 7.

<<NNOOTTEE>> The app does not support registration function. For registering your Control Panel in

initial setup, please use the website to access the server.

Page 5: Demo Home Portal Server User Guide 20150207

3

1.3. XMPP Setting For the Security Panels

Climax Security Control Panels utilizes XMPP to connect to Home Portal Server. The XMPP setting

is programmed by factory default to the Home Portal Server. Before proceeding with registration,

you should check your panel’s XMPP setting.

The Security panels include:

- VST-2735/VST-2752

- M-Series

- VST-1818 IP Camera

- HPGW Series

<<NNOOTTEE>>

The IP Cameras belongs to the “Security” selection.

To check the panel’s XMPP setting:

Step 1. Connect to the configuration page of your security systems. Please refer to your control panel user manual for more details.

Step 2. Find the XMPP setting page in your control panel webpage. The XMPP page location is different in each control panel. The example below is from M Series Control Panel.

DO NOT change any default XMPP parameters or the Control Panel will not be able to connect to

Home Portal Server. If you changed the parameters accidentally, follow information below to restore

your XMPP setting. The format may differ according to different panel, please apply the parameters

below accordingly.

Server: homeportal.climax.com.tw

Page 6: Demo Home Portal Server User Guide 20150207

4

Port Number: 5222

Domain: climax-home-portal

Buddy List: security_admin Step 3. If your control panel can successfully connect to the Home Portal Server, the webpage will

display the “Connected” message.

If the webpage does not display “Connected” status, it means the Control Panel is

not connected to Home Portal Server and cannot be registered, or controlled on

the server.

Page 7: Demo Home Portal Server User Guide 20150207

5

2. Registration The Home Portal Server has a mechanism which only allows registration within the first 15 minutes after a Control Panel is connected to the server. If the panel does not complete registration within 15 minutes, you should power down and restart the panel again to reconnect to server and reset the 15 minute timer.

Step 1. Before registration, connect the panel you wish to register to internet via either IP or GPRS/3G depending on the models.

Step 2. With a valid Internet connection, enter https://homeportal.climax.com.tw/ in your browser to access the web page of home portal server and click “New User”.

Step 3. If you have not connected your panel to internet and power on the panel, follow on screen instruction to do so.

Step 4. Enter the following information:

Account Info:

ID: Your account username which will be used to log into the server.

New Password: Enter a password for the user account

Confirm Password: Repeat the password as a confirmation

E-mail: Your email address

Page 8: Demo Home Portal Server User Guide 20150207

6

Click “Next” to proceed after entering all info.

Personal Info: Click “Next” to proceed after entering all infor.

Country Code: Enter your country code.

Mobile Phone: Your mobile phone number.

Address: Your physical address

Click “Next” to proceed after entering all info.

Registration Info:

MAC/IMEI: Enter the Control Panel’s MAC address, the MAC address can be found on

the label on the Control Panel.

Dealer Name: This function allows server to identify which dealer does the user account

belong to. For testing purpose, please enter “climax” as default.

Language: Select the display language.

Click “Submit” to proceed after entering all info.

Step 5. After clicking “Submit”, the server will connect to the Control Panel and complete the registration process.

If you see an error message, it may indicate one of the following situations.

Page 9: Demo Home Portal Server User Guide 20150207

7

XMPP Connection Error: The Control Panel is not connected to the server. The Control Panel

could be either powered down, or has internet connection problem. Please check its AC power

and network status.

In case of the control panel being mistaken as malware or virus, please check your firewall setting, make sure port TCP 5222 is open for XMPP connection and on your firewall exception list.

Check your router MAC address filter setting and make sure the MAC address of your control panel is authorized in your router.

If you are using the dial-up internet connection, please make sure your router supports ADSL PPPOE function.

Registration Time Expired: The Control Panel did not complete registration within 15 minutes

after connecting to the server for over 15 minutes

Step 6. If registration is successful, the webpage will display success message, click OK to confirm and return to server homepage.

Step 7. Check your email for the Authentication email sent to you from Home Portal Server. Click on the link in the email to authenticate the account, then proceed to log into the server using the ID and Password you just registered. Registration is complete

<IMPORTANT NOTICE>

Upon completing the registration, the Home Portal Server will automatically configure the report and upload setting of the panel to Home Portal Server. The first URL under the Control Panel’s Report and Upload webpage will be assigned to Home Portal Server. If you

Page 10: Demo Home Portal Server User Guide 20150207

8

have already configured the 1st URL of Report and Upload webpage in your control panel, the previous setting will be overwritten. Please refer to Control Panel manual report and upload section for detail.

For control panels with group report setting, if reporting to one of the URLs in a group is successful, the system will stop reporting to the rest of the group. After completing Home Portal registration, you should program all other report URLs to different group from Home Portal Server URL to make sure they can receive reports. Please refer to Control Panel manual report section details.

DO NOT change the report and upload URL setting to Home Portal Server, or Home Portal Server will not be able to receive event report and picture/video from your Control Panel. If you changed report and upload URL accidentally, use the Resend Configuration function in Home Portal Server’s Setting page to reprogram your Control Panel. See 2.2. Operation for detail.

<<EEXXAAMMPPLLEE>>

The format may vary slightly according to different panels.

Report:

HPGW Series

M Series

Page 11: Demo Home Portal Server User Guide 20150207

9

Upload:

HPGW Series

M Series

Page 12: Demo Home Portal Server User Guide 20150207

10

3. Operation 2.1. Log In

With a valid Internet connection, enter https://homeportal.climax.com.tw / in your browser to access the web page of home portal server.

Step 1. Enter your registered account ID and password and click “Connect” to log into your account. Check “Remember Me” if you want the webpage to remember your log in info for repeat access.

If you lost your registered password, click “Forgot Password”, enter your registered ID and click “Submit”.

The server will reset your password and create a new random password, then send the password to your registered email account.

Page 13: Demo Home Portal Server User Guide 20150207

11

Step 2. You will enter the main page of your account

Page 14: Demo Home Portal Server User Guide 20150207

12

2.2. Security

The Security page displays current system mode and security sensors/devices learnt in the Control panel for quick access.

Page 15: Demo Home Portal Server User Guide 20150207

13

2.2.1. System Area

Control Panel with only 1 area will display all sensors and system mode in the area. For Control

Panel with more than one area, such as HPGW series, select the operating area to display system

mode and sensor for the selected area only:

2.2.1. System Mode

System Mode: The system mode is indicated by the 3 buttons at top of the webpage. The current

system mode will light up.

To change system mode:

Step 1. Click on the desired mode button. You will be required to enter one of the Control Panel User PIN Code to confirm the action.

Page 16: Demo Home Portal Server User Guide 20150207

14

Step 2. Enter the User PIN Code, if the PIN Code is correct, for arming action, the Control Panel will begin Exit Time countdown.

If incorrect PIN Code is entered, the webpage will display error message and arming will

be aborted.

If the system has existing fault events when arming, the webpage will display fault

message and arming will be aborted. If you still want to arm the system, repeat the arming

action within 30 seconds to Force Arm.

Step 3. When arming/disarming is complete, the mode button will change accordingly.

Page 17: Demo Home Portal Server User Guide 20150207

15

2.2.2. Sensors

The sensor section lists all security function related accessory device in the system. (Home

Automation devices are not displayed.)

The sensors are listed in order of Zone Number. If a particular sensor has fault, the sensor’s column

will change to red color to alert the user. The fault event will be described at end of column.

For Camera type security devices (PIR Camera, PIR Video Camera and IP Camera), you can click

the camera icon at end of device column to manual control the camera to take a picture or video clip

2.2.3. IP Cam List

The IP Cam List shows the IP Cameras currently learnt in the Control Panel. Click on the IP Camera

Image to go to IP Cam page and view streaming video

Page 18: Demo Home Portal Server User Guide 20150207

16

2.3. Automation

The Automation page provides access to home automation functions in the Control Panel.

2.3.1. Device

The device subpage lists all available devices which can be displayed according to different

categories.

Select device category from top row to determine which devices should be displayed.

All: All devices are displayed.

Switches: Power Switch and Relay Switch.

Lighting: Light Switch and Dimmer.

Lock: Door Lock.

HVAC: Temperature control related devices, such as Temperature Sensor, Thermostat…etc

Page 19: Demo Home Portal Server User Guide 20150207

17

The bottom menu displayed device info according to category selected.

Device Status will be displayed in each device column.

Switch type device will display current on/off condition

Lock will display Lock/Unlock status

Power Switch with Meter will display current wattage and accumulated power consumption.

Dimmer will display current power output level.

Temperature and Humidity sensor will display temperature and humidity reading.

Use the device column to control each device or check detail information.

For Switch or Locks, click the ON/OFF or LOCK/UNLOCK icon to toggle its status.

For Dimmer, either click the ON/OFF icon to toggle or click the bar to adjust the output percentage.

For some devices with more detail control options, click the icon to enter the device’s own control page.

For Power Switch Meter or Temperature Sensor, click the icon to view the history graph of power consumption or temperature. (This function currently is not yet enabled)

Page 20: Demo Home Portal Server User Guide 20150207

18

2.3.2. Group

The group subpage allows you to assign more than one devices into one group and control app

devices in a group with a single action. (This function currently is not yet enabled)

Page 21: Demo Home Portal Server User Guide 20150207

19

2.3.3. Scene

The scene subpage allows you to configure Home Automation Scenes. A Scene includes a set of

actions which the Control Panel may perform with its Home Automation devices. The user can

program the Scene and associate it with a set of system condition and/or time schedule. The

Control Panel will then execute the Scene automatically when the condition or time schedule

requirement is met, or the user can also manually execute the scene via the server.

Create a New Scene.

Step 1. Click “Add scene” or the icon to access Add Scene menu.

Page 22: Demo Home Portal Server User Guide 20150207

20

Step 2. Enter a scene name.

Step 3. Select a scene icon for easy recognition.

Step 4. Select up to 3 devices from the available device list in the Control Panel, and select the device action to be performed.

Step 5. Set the Condition and/or Timer Schedule for the scene to be executed automatically. You must set at least one condition or schedule.

You can also click the icon on top right of condition setting to add a second set of condition and time schedule. If you program 2 sets of condition/time schedule, the scene will be executed automatically when either of the 2 sets of condition/time schedule is met.

Clicking icon will remove the condition/time schedule set.

Step 6. Click “Submit” to confirm scene setting. The Scene page will be updated with the new Scene

Page 23: Demo Home Portal Server User Guide 20150207

21

Apply Scene.

You can click the icon after the scene name to bypass the condition/time schedule setting and manually execute a scene’s action.

Edit Scene.

Step 1. To edit an existing scene, click the scene column to view scene content.

Page 24: Demo Home Portal Server User Guide 20150207

22

Step 2. Click icon at top right to access Edit Scene menu.

Step 3. Edit the Scene setting. Click . to remove existing device or condition/time setting; click icon to add new device or condition/time option.

Step 4. Click “Submit” to confirm scene change.

Delete Scene.

Step 1. Click icon to access delete scene menu.

Step 2. Check the box before the scene you want to delete and click “OK” to confirm.

Page 25: Demo Home Portal Server User Guide 20150207

23

2.4. IP Camera

The IP Camera page provides real time video streaming from your IP Cameras.

IP Cam List

If you have multiple IP Cameras in the Control Panel. Click each IP Camera’s respective image in the IP Cam List to change the currently streaming IP Camera

Record Video

Click icon to record a video clip. The IP Camera will record video clip according to its internal setting (Please refer to IP Camera manual for detail).

Page 26: Demo Home Portal Server User Guide 20150207

24

2.5. Event

The Event page records all alarm/status event, pictures and video transmitted from the Control Panel.

Select the event category to determine what events are displayed

All

The Event page will display all received events and picture/video.

Media:

The Event page will only display received pictures and videos, no alarm or status event will be displayed.

Alarm:

The Event page will only display alarm events. Status events and picture/videos will not be displayed.

Date:

Select a date, the Event page will only display events and picture/video received on selected date.

Page 27: Demo Home Portal Server User Guide 20150207

25

2.6. Setting

The Setting page includes Control Panel device, operation and reporting setting options.

2.6.1. Device

The Device setting subpage includes the following functions:

Device List and Edit Device

The Device List includes information of all accessory devices learnt in the Control Panel, including their current status. To edit the device, click the icon at end of each device info column to enter Edit Device Page.

Page 28: Demo Home Portal Server User Guide 20150207

26

Refer to the Control Panel manual to complete editing device and click Submit to confirm.

Device Learning

Step 1. Click icon to enter learning mode.

Step 2. Refer to accessory device manual to transmit learn signal from the device. When the

panel receives learn signal, the webpage will display device info.

Step 3. Check the box in front of device info, then click OK to add the device into Control Panel.

Page 29: Demo Home Portal Server User Guide 20150207

27

Walk Test

Step 1. Click icon to enter Walk Test mode.

Step 2. Refer to device menu and press the test button to transmit a test signal for signal range

test. When the signal is received, the webpage will be updated to show device info and signal strength in RSSI value. (IP Camera will send signal automatically upon entering Walk Test and does not require button press. )

Refresh Device List

Click icon to refresh device list info.

Page 30: Demo Home Portal Server User Guide 20150207

28

Delete Device

Step 1. To remove learnt in devices, click icon to access delete device menu.

Step 2. Check the box at end of device column and click OK to remove selected devices from panel..

Page 31: Demo Home Portal Server User Guide 20150207

29

2.6.2. Panel

The Panel setting page provides access to Control Panel operation settings.

Refer to the Control Panel manual to program the parameters and click “Submit” at bottom of

page to confirm setting.

Click icon at top right corner to access panel information

Page 32: Demo Home Portal Server User Guide 20150207

30

If you accidentally changed the Report URL 1 and Upload URL 1 settings in the Control Panel after registration and could no longer receive report or picture/video upload from panel, please click “Resend Configuration” at bottom of page to reset panel Report and Upload setting to Home Portal Server.

Page 33: Demo Home Portal Server User Guide 20150207

31

2.6.3. Report

The Report setting page allows you to program system event and picture/video delivery settings.

SMS Report.

Upon receiving a report sent from Control Panel, the Server can forward the event by SMS message to programmed mobile numbers. The mobile number entered in registration will be used as default number.

Click icon to add new SMS report number.

For each number, select the type of events to be reported to this number. Options include:

None: No events will be report

All: All alarm and status event will be reported

Burglar: Only alarm event will be reported.

SMS Reporting requires credit. Each SMS report to a mobile number will consume one SMS credit. When SMS credit reaches 0, the server will stop sending SMS reports. To check remaining SMS credit, move the mouse cursor over icon to display SMS credit.

<<NNOOTTEE>>

SMS Report function is currently disabled, if you wish to test this function, please contact climax staff.

Page 34: Demo Home Portal Server User Guide 20150207

32

Email Report

The email report functions in the same way as SMS report, but does not require any credits. Besides events, the server will also send any picture or video received to programmed email accounts. The email account entered in registration will be used as default.

Click icon to add new email account. Click to remove existing email accounts. Default email account cannot be removed.

For each email account, select the type of events to be reported to this number. Options include:

None: No events will be report

All: All alarm and status event will be reported

Burglar: Only alarm event will be reported.

Push Report

Program the Push Notification setting for mobile devices. Select the type of events to be reported to this number. Options include:

None: No events will be report

All: All alarm and status event will be reported

Burglar: Only alarm event will be reported.

Capture File

Capture File setting allows user to access the “Upload” setting of Control Panel.

URL1 is set to Home Portal Server and cannot be modified. To program URL2 to URL5, select an upload type from the drop down menu and enter the parameters.

HTTP: enter the web link

FTP: Enter FTP info in following format: user:password@server:port/path

Email: Enter an email account

MMS: Enter a mobile number.

Page 35: Demo Home Portal Server User Guide 20150207

33

<<IIMMPPOORRTTAANNTT NNOOTTEE>>

To use email upload function, the Control Panel’s SMTP setting must be programmed, please refer to Control Panel manual for detail.

To use MMS upload function, the Control Panel must support MMS and its related setting must be programmed, please refer to Control Panel manual for detail.

Click “SUBMIT” to confirm after finish all settings.

Page 36: Demo Home Portal Server User Guide 20150207

34

2.7. Account

The account page display user account info. To access account page, click the drop down menu at

top right of screen and select “Account”, or click icon at top left

Change Avatar

Click “Change Avatar” to change your avatar picture.

Click icon, select the new avatar picture in your computer, then click “Upload” to confirm.

Change Password

Click “Change Password”, enter your current log in password, then enter the new password and repeat the new password and click “Submit” to confirm.

Page 37: Demo Home Portal Server User Guide 20150207

35

Contact Info

Click to access Contact Info..