Documentation [smartVISU]

Configuration

Global
Pages 'docu'
Client (Cookie)

Global system settings (in ./config.ini).

User Interface

General Settings

Pages

Defines which of the pages in the ./pages folder is displayed by default.

Design

Defines the look and feel.

Title

Page title in the browser tab.

Language

Sets the language to be used by smartVISU.
Further translations are appreciated!
Note: Not all widgets are multi-lingual.

Cache

Are pages to be cached for faster loading? The cache needs to be cleared to apply page changes (=switch off for pages under development).

Behaviour

Animation

Use animation between pages.

Back to home

Seconds of inactivity until home page is shown.
Set to 0 to disable returning automatically.

Time

Which time to be used by clock widgets?
client = time of your device
server = smartVISU server time

Timezone

Timezone of the server's location (!)

SmartHome/IoT data source

Data connection / driver

System

Which system gathers the data?

Host/IP

Host name or IP address the system can be reached at (e.g. 192.168.1.2)
If left empty hostname of HTTP request will be used in most systems.

Port

The port the system can be reached at, e.g.:
1028 - LinKNX
2121 - FHEM
2424 - smartHomeNG
If left empty the port of HTTP request will be used in most systems.

TLS-Port

The port for TLS-encrypted communication, e.g. 2425 with smartHomeNG. The driver uses this port if the visu page is called via HTTPS.

Realtime data

Observe system online for data changes?

Reconnect

Automatically reconnect in case of a connection drop?

Rev. Proxy

If the server is configured as reverse proxy the fields for IP address and port must be empty

Console

Consoleport

The port the console can be reached at, e.g.:
8101 - OpenHAB

Username

The username for authentication on the console.

Password

The password to the username.
ATTENTION: The password is saved unencrypted in config.ini.

Authentication / Security

SSL

Activate for encrypted communication with the server and, if necessary, adjust the port settings to the SSL port, if different from 443.
Recommended when using authentication with a password.
ATTENTION: The server's certificate must be trustworthy on the client, otherwise the connection is refused.

Username

The username or API token for authentication on the server.

Password

The password for the username. Usually empty when using an API token.
ATTENTION: The password is saved unencrypted in config.ini and if SSL is not activated it is also transmitted unencrypted to the server.

smartVISU Host Name / Proxy Server

SV Host Name

If smartVISU gets called with its host name in the internal net,
e.g. as smartVISU.local, the host name must be entered here. (optional if IP address is being used)

Proxy

Activate this setting if the smartVISU server is connecting to the Internet through a proxy server.

Host/IP

The address of the proxy server.

The user name for login to the proxy server.

Password

The password for login to the proxy server.

Other Data Sources

Weather

Provider

Name of the weather service.

City

Your location in the format of your weather service
(e.g. Germany/Bayern/Würzburg/)
or your Wunderground station code

API Key

Your key / password if you are a registered user of the service (required by some services, otherwise number of requests per hour / day may be limited).

Postal code

Postal code : Country code, e.g. 70000:DE

Phone

System

The driver to be used for your phone system.

Host/IP

Host name or IP address to acccess your phone system (e.g. 192.168.1.1)

Port

The port to access your phone system (if required).

The user name for logging in to your phone system (e.g. admin).

Password

The password for logging in to your phone system.

Calendar

Provider

The driver to be used for your calendar service.

URL(s)

The address for connecting to your calendar service.
For ICS/iCal, you can add more than one URL, separated by whitespace.

The user name to be used for login at the calendar provider (if required).

Password

The password to be used for login at the calendar provider (if required).

Calendars

One or more calendar names to be read (separated by comma, e.g. calendar1,calendar2)

Color(s)

Default colors for the above calendar(s), in the same order.

Hide private

Hide private info by showing titles of private entires as "private appointment"

Access

Authorize Google Data Access

Authorize

Options

Functions

Check for updates

Look on smartvisu.de and github for a newer version.

item loopback

After sending commands from the visu, item gets updated only by an answer of the backend. (Deactivated: item gets updated immediatly inside smartVISU.)

Settings for the selected page only (in /pages/docu/config.ini).

User Interface

General Settings

Pages

Defines which of the pages in the ./pages folder is displayed by default.

Design

Defines the look and feel.

Title

Page title in the browser tab.

Language

Sets the language to be used by smartVISU.
Further translations are appreciated!
Note: Not all widgets are multi-lingual.

Cache

Are pages to be cached for faster loading? The cache needs to be cleared to apply page changes (=switch off for pages under development).

Behaviour

Animation

Use animation between pages.

Back to home

Seconds of inactivity until home page is shown.
Set to 0 to disable returning automatically.

Time

Which time to be used by clock widgets?
client = time of your device
server = smartVISU server time

Timezone

Timezone of the server's location (!)

SmartHome/IoT data source

Data connection / driver

System

Which system gathers the data?

Host/IP

Host name or IP address the system can be reached at (e.g. 192.168.1.2)
If left empty hostname of HTTP request will be used in most systems.

Port

The port the system can be reached at, e.g.:
1028 - LinKNX
2121 - FHEM
2424 - smartHomeNG
If left empty the port of HTTP request will be used in most systems.

TLS-Port

The port for TLS-encrypted communication, e.g. 2425 with smartHomeNG. The driver uses this port if the visu page is called via HTTPS.

Realtime data

Observe system online for data changes?

Reconnect

Automatically reconnect in case of a connection drop?

Rev. Proxy

If the server is configured as reverse proxy the fields for IP address and port must be empty

Console

Consoleport

The port the console can be reached at, e.g.:
8101 - OpenHAB

Username

The username for authentication on the console.

Password

The password to the username.
ATTENTION: The password is saved unencrypted in config.ini.

Authentication / Security

SSL

Username

The username or API token for authentication on the server.

Password

smartVISU Host Name / Proxy Server

SV Host Name

If smartVISU gets called with its host name in the internal net,
e.g. as smartVISU.local, the host name must be entered here. (optional if IP address is being used)

Proxy

Activate this setting if the smartVISU server is connecting to the Internet through a proxy server.

Host/IP

The address of the proxy server.

The user name for login to the proxy server.

Password

The password for login to the proxy server.

Other Data Sources

Weather

Provider

Name of the weather service.

City

Your location in the format of your weather service
(e.g. Germany/Bayern/Würzburg/)
or your Wunderground station code

API Key

Your key / password if you are a registered user of the service (required by some services, otherwise number of requests per hour / day may be limited).

Postal code

Postal code : Country code, e.g. 70000:DE

Phone

System

The driver to be used for your phone system.

Host/IP

Host name or IP address to acccess your phone system (e.g. 192.168.1.1)

Port

The port to access your phone system (if required).

The user name for logging in to your phone system (e.g. admin).

Password

The password for logging in to your phone system.

Calendar

Provider

The driver to be used for your calendar service.

URL(s)

The address for connecting to your calendar service.
For ICS/iCal, you can add more than one URL, separated by whitespace.

The user name to be used for login at the calendar provider (if required).

Password

The password to be used for login at the calendar provider (if required).

Calendars

One or more calendar names to be read (separated by comma, e.g. calendar1,calendar2)

Color(s)

Default colors for the above calendar(s), in the same order.

Hide private

Hide private info by showing titles of private entires as "private appointment"

Access

Authorize Google Data Access

Authorize

Options

Functions

Check for updates

Look on smartvisu.de and github for a newer version.

item loopback

After sending commands from the visu, item gets updated only by an answer of the backend. (Deactivated: item gets updated immediatly inside smartVISU.)

Settings for the current client only (stored as cookie).

User Interface

General Settings

Pages

Defines which of the pages in the ./pages folder is displayed by default.

Design

Defines the look and feel.

Title

Page title in the browser tab.

Language

Sets the language to be used by smartVISU.
Further translations are appreciated!
Note: Not all widgets are multi-lingual.

Cache

Are pages to be cached for faster loading? The cache needs to be cleared to apply page changes (=switch off for pages under development).

Behaviour

Animation

Use animation between pages.

Back to home

Seconds of inactivity until home page is shown.
Set to 0 to disable returning automatically.

Time

Which time to be used by clock widgets?
client = time of your device
server = smartVISU server time

Timezone

Timezone of the server's location (!)

SmartHome/IoT data source

Data connection / driver

System

Which system gathers the data?

Host/IP

Host name or IP address the system can be reached at (e.g. 192.168.1.2)
If left empty hostname of HTTP request will be used in most systems.

Port

The port the system can be reached at, e.g.:
1028 - LinKNX
2121 - FHEM
2424 - smartHomeNG
If left empty the port of HTTP request will be used in most systems.

TLS-Port

The port for TLS-encrypted communication, e.g. 2425 with smartHomeNG. The driver uses this port if the visu page is called via HTTPS.

Realtime data

Observe system online for data changes?

Reconnect

Automatically reconnect in case of a connection drop?

Rev. Proxy

If the server is configured as reverse proxy the fields for IP address and port must be empty

Console

Consoleport

The port the console can be reached at, e.g.:
8101 - OpenHAB

Username

The username for authentication on the console.

Password

The password to the username.
ATTENTION: The password is saved unencrypted in config.ini.

Authentication / Security

SSL

Username

The username or API token for authentication on the server.

Password

smartVISU Host Name / Proxy Server

SV Host Name

If smartVISU gets called with its host name in the internal net,
e.g. as smartVISU.local, the host name must be entered here. (optional if IP address is being used)

Proxy

Activate this setting if the smartVISU server is connecting to the Internet through a proxy server.

Host/IP

The address of the proxy server.

The user name for login to the proxy server.

Password

The password for login to the proxy server.

Other Data Sources

Weather

Provider

Name of the weather service.

City

Your location in the format of your weather service
(e.g. Germany/Bayern/Würzburg/)
or your Wunderground station code

API Key

Your key / password if you are a registered user of the service (required by some services, otherwise number of requests per hour / day may be limited).

Postal code

Postal code : Country code, e.g. 70000:DE

Phone

System

The driver to be used for your phone system.

Host/IP

Host name or IP address to acccess your phone system (e.g. 192.168.1.1)

Port

The port to access your phone system (if required).

The user name for logging in to your phone system (e.g. admin).

Password

The password for logging in to your phone system.

Calendar

Provider

The driver to be used for your calendar service.

URL(s)

The address for connecting to your calendar service.
For ICS/iCal, you can add more than one URL, separated by whitespace.

The user name to be used for login at the calendar provider (if required).

Password

The password to be used for login at the calendar provider (if required).

Calendars

One or more calendar names to be read (separated by comma, e.g. calendar1,calendar2)

Color(s)

Default colors for the above calendar(s), in the same order.

Hide private

Hide private info by showing titles of private entires as "private appointment"

Access

Authorize Google Data Access

Authorize

Options

Functions

Check for updates

Look on smartvisu.de and github for a newer version.

item loopback

After sending commands from the visu, item gets updated only by an answer of the backend. (Deactivated: item gets updated immediatly inside smartVISU.)

Sign in to Google Developer Console.
Under API Project (top left beside Google APIs) select Create project.
Enter a Project Name, e.g. "smartVISU calendar" and click on CREATE.
- Wait while the project gets created.
Click on Calendar API under Google Apps APIs.
Click ► ENABLE on top.
Click on Create credentials on top right.
1. Select Google Calendar API under Which API are you using?
2. Select Webserver (e.g. node.js, Tomcat) under Where will you be calling the API from?
3. Select User data under What data will you be accessing?
Click What credentials do I need?
1. Enter a custom name if you like, e.g. "My smartVISU".
2. Copy & paste the following specific URI to Authorized JavaScript origins. Exact match is important!
3. Authorized redirect URIs may be left empty.
Click on Create client ID.
Enter "smartVISU" for Product name shown to users and click on Continue.
You will then see your Client-ID. Click on Download and save the file.
Select this file here: If the fields client ID and client secret below don't get filled:
Open the file, look for values of client_id and client_secret and enter them.
Click on Authorize below.
Log in if asked and click on Grant in opened window.
- The popup window and this dialog should close afterwards. Authorization procedure is completed now.
Don't forget to save the configuration page.

google_json_text

Client-ID:

Client Secret:

Configuration

Global system settings (in ./config.ini).

User Interface

General Settings

Behaviour

SmartHome/IoT data source

Data connection / driver

Console

Authentication / Security

smartVISU Host Name / Proxy Server

Other Data Sources

Weather

Phone

Calendar

Options

Functions

Settings for the selected page only (in /pages/docu/config.ini).

User Interface

General Settings

Behaviour

SmartHome/IoT data source

Data connection / driver

Console

Authentication / Security

smartVISU Host Name / Proxy Server

Other Data Sources

Weather

Phone

Calendar

Options

Functions

Settings for the current client only (stored as cookie).

User Interface

General Settings

Behaviour

SmartHome/IoT data source

Data connection / driver

Console

Authentication / Security

smartVISU Host Name / Proxy Server

Other Data Sources

Weather

Phone

Calendar

Options

Functions

Configuration

Template checker

Widget Assistant

Documentation

Support on knx-user-forum

Source & Issues on GitHub

Team

Credits

Copyright