Differences
This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
quickguide [2020/09/08 10:00] – [Step 2. Choosing The Right Thinknx Server] ingrid | quickguide [2024/05/10 08:57] (current) – francesco | ||
---|---|---|---|
Line 1: | Line 1: | ||
====== Thinknx Quick Guide ====== | ====== Thinknx Quick Guide ====== | ||
- | [[quickguide# | + | [[:quickguide# |
- | [[quickguide# | + | [[:quickguide#step_2_choosing_the_right_thinknx_server|Step 2. Choosing The Right Thinknx Server]] |
- | [[quickguide# | + | [[:quickguide# |
- | [[quickguide# | + | [[:quickguide# |
- | [[quickguide# | + | [[:quickguide# |
- | + | ||
- | [[quickguide# | + | |
+ | [[: | ||
< | < | ||
- | ==== Step 1. Downloading The Software ==== | + | ==== Step 1. Downloading The Software ==== |
- | {{ : | + | |
- | <WRAP center 60%> <WRAP centeralign> | + | {{ : |
- | ThinKnx UP Configurator software is the indispensable tool for the creation and development of a supervision project. It is a complete solution to designing attractive graphical user interfaces, determining clients behavior and configuring functions and services. | + | |
- | The software can be downloaded [[http:// | + | |
System requirements for Thinknx UP Configurator: | System requirements for Thinknx UP Configurator: | ||
- | | + | |
- | * 64-bit system | + | * **Microsoft Windows 7 or above** |
- | * Updated graphic card driver supporting DirectX 10 | + | |
+ | | ||
For project visualization, | For project visualization, | ||
- | * Apple - [[https:// | ||
- | * Android - [[https:// | ||
- | * Windows - [[http:// | ||
- | * Mac - [[http:// | ||
- | <WRAP round important center 80%> ThinKnx Player for Mac is an Air application, | + | * ** Apple - [[https:// |
- | < | + | * ** Android - [[https:// |
- | ==== Step 2. Choosing The Right Thinknx Server ==== | + | * ** Windows - [[https:// |
- | <WRAP Group>< | + | * ** Mac - [[http:// |
- | \\ \\ Thinknx provides different types of product divided into two major lines: | + | |
- | * **Pro Line** a professional range of servers able to interact with complex systems and communicate with multiple protocols: | + | <WRAP round important center 80%> ThinKnx Player for Mac is an Air application, |
- | * <color #6e99c7> Micro_20 //(Micro DIN coming soon)// | + | |
- | * <color #6e99c7>Compact (//Compact_20 and Compact DIN coming soon)//</ | + | ==== Step 2. Choosing The Right Thinknx Server ==== |
- | * <color # | + | |
- | * <color # | + | <WRAP Group>< |
- | | + | Thinknx provides different types of product divided into two major lines: |
- | * <color # | + | |
+ | * **Pro Line** a professional range of servers able to interact with complex systems and communicate with multiple protocols: | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
* **Trend Line** an affordable solution tailored for simpler plants purely based on KNX, and has limited functionalities in terms of integration with other systems: | * **Trend Line** an affordable solution tailored for simpler plants purely based on KNX, and has limited functionalities in terms of integration with other systems: | ||
- | * <color #6e99c7>King //coming soon//</ | + | |
- | * <color #6e99c7>Quick //coming soon//</ | + | * **<color # |
- | * **Thinknx Multiroom Audio System** | + | |
- | * <color # | + | * **<color # |
- | * <color # | + | * **Universal Modular KNX Gateway** |
- | </WRAP> | + | |
- | <WRAP column half> | + | * **Thinknx Multiroom Audio System** |
- | <WRAP centeralign> | + | |
- | <WRAP centeralign> | + | |
- | </ | + | * ** <color #6e99c7>Audiofy expansion E4 </color> ** |
- | \\ Choosing the suitable server for any project is directly linked to the type of system that needs to be integrated with Thinknx (For example, a Micro Server cannot be used for an integration with an alarm system or Modbus).Therefore, | + | </ |
+ | |||
+ | \\ | ||
+ | Choosing the suitable server for any project is directly linked to the type of system that needs to be integrated with Thinknx (For example, a Micro Server cannot be used for an integration with an alarm system or Modbus).Therefore, | ||
- | <WRAP centeralign> | + | <WRAP centeralign> |
- | <WRAP centeralign> | + | |
< | < | ||
+ | |||
==== Step 3. Setting Up The Server ==== | ==== Step 3. Setting Up The Server ==== | ||
- | **Step 3.1. Connect Server to Network and Power** | ||
- | \\ For an easy setup, connect the server to a network that has DHCP enabled. Connect the server to the power, making sure to respect the correct voltage needed for each server type. | ||
- | < | + | **Step 3.1. Connect Server to Network and Power** \\ |
- | <WRAP centeralign> | + | For an easy setup, connect the server to a network that has DHCP enabled. Connect the server to the power, making sure to respect the correct voltage needed for each server type. < |
+ | If you want to install DIN rail power supplies with your Thinknx servers, we recommend to avoid routing the cables together with other noisy cables and to tune the power supply' | ||
- | \\ **Step 3.2. Scan for Available Servers** | ||
- | \\ Once server is powered up, connect PC to the same network and access the scanning tool directly from Configurator. This tool will show all the Thinknx servers detected on the LAN and their corresponding IP addresses. | ||
- | \\ <WRAP tip center round 80%> Always make sure that no firewall or antivirus are preventing the Configurator from scanning the network. </ | ||
\\ | \\ | ||
- | <WRAP centeralign> | + | **Step 3.2. Scan for Available Servers** \\ |
- | <WRAP centeralign> | + | Once server is powered up, connect PC to the same network and access the scanning tool directly from Configurator. This tool will show all the Thinknx servers detected on the LAN and their corresponding IP addresses.\\ |
+ | <WRAP tip center round 80%> Always make sure that no firewall or antivirus are preventing the Configurator from scanning the network. </ | ||
+ | |||
+ | <WRAP tip center round 80%>In case the Configurator tool fails, you can always scan for the available servers by inputting the following path on your internet browser: [[https:// | ||
+ | <WRAP centeralign> | ||
- | \\ **Step 3.3. Access Web Interface** | ||
- | \\ Access to web interface can be done by clicking on the "Open Server Webpages" | ||
\\ | \\ | ||
- | At the login page, the following credentials must be used: <wrap hi> | + | **Step 3.3. Access Web Interface** \\ |
+ | Access to web interface can be done by clicking on the "Open Server Webpages" | ||
+ | At the login page, the following credentials must be used: <wrap hi> | ||
+ | <WRAP centeralign> | ||
\\ | \\ | ||
- | <WRAP centeralign> | + | **Step 3.4. Update Firmware to Latest Version** \\ |
- | <WRAP centeralign> | + | If the server is already connected to the Internet, it is always advised to update the firmware to the latest version in order to avoid system bugs.\\ |
+ | To do that, go to the " | ||
+ | <WRAP centeralign> | ||
- | \\ **Step 3.4. Update Firmware to Latest Version** | ||
- | \\ If the server is already connected to the Internet, it is always advised to update the firmware to the latest version in order to avoid system bugs. | ||
- | \\ To do that, go to the " | ||
\\ | \\ | ||
- | <WRAP centeralign> | + | **Step 3.5. Fix Date and Time** \\ |
- | <WRAP centeralign> | + | Having the correct date and time configured in the server is crucial in order not to mess the switching schedules programmed in the Thinknx application.\\ |
+ | To change Date and Time, go to " | ||
+ | <WRAP centeralign> | ||
- | \\ **Step 3.5. Fix Date and Time** | ||
- | \\ Having the correct date and time configured in the server is crucial in order not to mess the switching schedules programmed in the Thinknx application. | ||
\\ | \\ | ||
- | To change Date and Time, go to " | + | **Step 3.6. Configure IP Address** \\ |
- | \\ | + | All Thinknx Servers are, by default, configured |
- | <WRAP centeralign> | + | However, it is advised to always switch from DHCP to a fixed IP address which will allow the user to know the server IP address at any moment disregarding the settings of the network it is connected to.\\ |
- | <WRAP centeralign> | + | To enter a fixed IP address into the server, click on the " |
+ | To access | ||
+ | <WRAP tip center round 80%> Whenever a fixed IP is used, the network interface of the server will be configured in such a way so that it will always be reachable at the IP address 192.168.24.254/ | ||
- | \\ **Step 3.6. Configure IP Address** | ||
- | \\ All Thinknx Servers are, by default, configured to use DHCP if the network will allow it. In the absence of a DHCP service, it will acquire the following default IP address: 192.168.0.200. | ||
- | \\ However, it is advised to always switch from DHCP to a fixed IP address which will allow the user to know the server IP address at any moment disregarding the settings of the network it is connected to. | ||
- | \\ To enter a fixed IP address into the server, click on the " | ||
- | \\ To access the server' | ||
- | \\ <WRAP tip center round 80%> Whenever a fixed IP is used, the network interface of the server will be configured in such a way so that it will always be reachable at the IP address 192.168.24.254/ | ||
- | <WRAP centeralign> | ||
- | <WRAP centeralign> | ||
- | < | ||
==== Step 4. Creating The First Project ==== | ==== Step 4. Creating The First Project ==== | ||
- | Projects can be created using a dedicated wizard tool, which will be automatically launched by clicking on the “New” button. | ||
- | \\ The data required by the wizard tool is: | ||
- | * Project name | ||
- | * Server type and serial number | ||
- | * Server IP address | ||
- | * Geo-localization coordinates (optional) | ||
- | * List of users (optional) | ||
- | * Licenses (optional) | ||
- | <WRAP centeralign> | + | Projects can be created using a dedicated wizard tool, which will be automatically launched by clicking on the “New” button.\\ |
- | \\ <WRAP centeralign> | + | The data required by the wizard tool is: |
+ | |||
+ | * **Project name** | ||
+ | * **Server type and serial number** | ||
+ | * **Server IP address** | ||
+ | * **Geo-localization coordinates (optional)** | ||
+ | * **List of users (optional)** | ||
+ | * **Licenses (optional)** | ||
+ | |||
+ | <WRAP centeralign> | ||
+ | <WRAP centeralign> | ||
If the data is unknown when creating a new project, clicking END after naming the project will close the wizard and create the project. The missing data can be entered later by going to the System tab, and clicking on System in the list, as seen in the below picture. | If the data is unknown when creating a new project, clicking END after naming the project will close the wizard and create the project. The missing data can be entered later by going to the System tab, and clicking on System in the list, as seen in the below picture. | ||
- | \\ <WRAP centeralign> | + | \\ |
- | \\ <WRAP centeralign> | + | <WRAP centeralign> |
+ | <WRAP centeralign> | ||
- | For more information regarding the Project Creation Wizard, check out our [[proj_creation| Project Creation]] page. | + | For more information regarding the Project Creation Wizard, check out our [[:proj_creation|Project Creation]] page.\\ |
- | \\ Once the project is created, it is now possible to start designing the interface. The integrator will be able to do the following: | + | Once the project is created, it is now possible to start designing the interface. The integrator will be able to do the following: |
- | * Enabling/ | + | |
- | * Creating new **pages** under each function | + | |
- | * Adding different **interface elements** for each page (buttons, pictures, indicators, etc). For more information regarding each interface object, check out our [[inter_objs| Interface Objects]] page. | + | |
- | * Creating **system objects** to be linked to their corresponding elements in the interface (HVAC controller, RGB controller, etc). For more information regarding each System object, check out our [[system_objs| System Objects]] page. | + | |
- | \\ <WRAP group> | + | * **Enabling/ |
- | <WRAP column half> | + | * **Creating new pages under each function** |
- | <WRAP centeralign> | + | * **Adding different interface elements for each page (buttons, pictures, indicators, etc). For more information regarding each interface |
- | \\ <WRAP centeralign> | + | * **Creating system objects |
- | </ | + | |
- | <WRAP column half> | + | |
- | <WRAP centeralign> | + | |
- | \\ <WRAP centeralign> | + | |
- | </ | + | |
- | </ | + | |
- | \\ <WRAP tip center round 80%> It is always recommended to save the project inside the Configurator, | + | \\ |
- | <WRAP centeralign> | + | <WRAP group> <WRAP column half> <WRAP centeralign> |
- | <WRAP centeralign> | + | <WRAP centeralign> |
+ | <WRAP centeralign> | ||
+ | |||
+ | \\ | ||
+ | <WRAP tip center round 80%> It is always recommended to save the project inside the Configurator, | ||
< | < | ||
+ | |||
==== Step 5. Deploying The Project ==== | ==== Step 5. Deploying The Project ==== | ||
- | A Thinknx project can be defined as a folder containing all the configuration files and all the settings related to a specific plant. All files imported in the project (such as ETS, images, etc.) are copied and stored in the project folder. | ||
- | \\ More information can be found on our [[proj_deploy| Project Deployment]] page. | ||
- | \\ When a project' | ||
- | * [[quickguide# | ||
- | * [[quickguide# | ||
- | \\ <WRAP important round center 80%> Deploying the project should be done to Thinknx server AND client together, after each modification. If the project version on the server does not match the version on the client, the application will not work correctly.</ | ||
- | \\ === Method 1: Using the local network === | + | A Thinknx project can be defined as a folder containing all the configuration files and all the settings related to a specific plant. All files imported in the project (such as ETS, images, etc.) are copied and stored in the project folder.\\ |
+ | More information can be found on our [[: | ||
+ | When a project' | ||
+ | |||
+ | * **[[: | ||
+ | * **[[: | ||
+ | |||
+ | \\ | ||
+ | <WRAP important round center 80%> Deploying the project should be done to Thinknx server AND client together, after each modification. If the project version on the server does not match the version on the client, the application will not work correctly.</ | ||
+ | |||
+ | === Method 1: Using the local network === | ||
This method should be used when the Thinknx server is connected to a local network but has no access to the Internet. However, it requires the use of a PC with the Thinknx Configurator installed as well as the availability of all the client devices on site. The PC and the clients should be connected to the same network as the Thinknx server. | This method should be used when the Thinknx server is connected to a local network but has no access to the Internet. However, it requires the use of a PC with the Thinknx Configurator installed as well as the availability of all the client devices on site. The PC and the clients should be connected to the same network as the Thinknx server. | ||
- | | + | |
- | * | + | |
- | <WRAP centeralign> | + | |
- | <WRAP centeralign> | + | |
- | | + | <WRAP centeralign> |
- | * After deploying the project to the local server, you will automatically be asked if you wish to do the same for the client. If the automatic request does not show, you can click on " | + | |
- | | + | |
+ | | ||
+ | |||
+ | <WRAP centeralign> | ||
+ | <WRAP Group> <WRAP column half centeralign> | ||
+ | |||
+ | === Method 2: Using Thinknx Cloud === | ||
- | <WRAP centeralign> | ||
- | <WRAP centeralign> | ||
- | \\ <WRAP Group> | ||
- | <WRAP column half centeralign> | ||
- | {{ : | ||
- | <WRAP centeralign> | ||
- | </ | ||
- | <WRAP column half centeralign> | ||
- | {{ : | ||
- | <WRAP centeralign> | ||
- | </ | ||
- | </ | ||
- | | ||
This method is more popular than the previous one because it allows to deploy the project to the server and clients even remotely. The main condition to achieve this is to have the Thinknx server connected to the Internet. | This method is more popular than the previous one because it allows to deploy the project to the server and clients even remotely. The main condition to achieve this is to have the Thinknx server connected to the Internet. | ||
+ | |||
* **Step 1: Enabling Thinknx Cloud on the server** | * **Step 1: Enabling Thinknx Cloud on the server** | ||
- | In the web interface of the Thinknx server, click on " | + | |
- | \\ <WRAP Group> | + | In the web interface of the Thinknx server, click on " |
- | <WRAP column half centeralign> | + | <WRAP Group> <WRAP column half centeralign> |
- | {{ :quickguide_enableCloudServer.png?direct500 | + | |
- | <WRAP centeralign> | + | |
- | </ | + | |
- | <WRAP column half centeralign> | + | |
- | {{ :quickguide_enableCloudServer2.png?direct360 | + | |
- | <WRAP centeralign> | + | |
- | </ | + | |
- | </ | + | |
- | \\ | + | |
* **Step 2: Configuring Cloud inside the Configurator** | * **Step 2: Configuring Cloud inside the Configurator** | ||
- | Open project inside Thinknx Configurator and enable Thinknx Cloud in the " | + | |
- | \\ It is also important to enable **" | + | Open project inside Thinknx Configurator and enable Thinknx Cloud in the " |
- | \\ Finally, selecting "Local and Cloud" for the **" | + | It is also important to enable **" |
- | \\ <WRAP centeralign> | + | Enabling **" |
- | <WRAP centeralign> | + | Finally, selecting "Local and Cloud" for the **" |
+ | <WRAP centeralign> | ||
* **Step 3: Uploading the file to the Cloud** | * **Step 3: Uploading the file to the Cloud** | ||
- | Inside Thinknx Configurator, | + | |
- | <WRAP centeralign> | + | Inside Thinknx Configurator, |
- | <WRAP centeralign> | + | |
* **Step 4: Downloading the project onto the client device** | * **Step 4: Downloading the project onto the client device** | ||
- | Open Thinknx application and go to Settings. Select the Cloud icon, and enter the serial number of the server and its corresponding password (Cloud password). | + | |
- | <WRAP TIP round center 80%>If users have been created inside Configurator, | + | Open Thinknx application and go to Settings. Select the Cloud icon, and enter the serial number of the server and its corresponding password (Cloud password). <WRAP TIP round center 80%>If users have been created inside Configurator, |
- | <WRAP centeralign> | + | |
- | <WRAP centeralign> | + | |
- | < | + | |
==== Step 6. Authenticating Clients ==== | ==== Step 6. Authenticating Clients ==== | ||
- | Whenever the client uses the Thinknx application, | + | |
- | The first time the client opens the loaded project, the server requests an authentication of the device. | + | Whenever the client uses the Thinknx application, |
* **Authentication via local network:** | * **Authentication via local network:** | ||
+ | |||
This method only works if there is direct access to the server' | This method only works if there is direct access to the server' | ||
- | | + | |
- | | + | * **The Client Authentication is done on the server’s web page, under Server |
- | * Click on “Add client code” and check the “Enabled” box. | + | |
- | \\ <WRAP Group> | + | \\ |
- | <WRAP column half centeralign> | + | <WRAP Group> <WRAP column half centeralign> |
- | <WRAP centeralign> | + | |
- | </ | + | |
- | <WRAP column half centeralign> | + | |
- | {{ :quickguide_authenticationLocal.png?direct350 | + | |
- | <WRAP centeralign> | + | |
- | </ | + | |
- | </ | + | |
* ** Authentication via Cloud** | * ** Authentication via Cloud** | ||
- | The authentication can be done remotely without the need to access the server' | ||
- | Another requirement is to have «Thinknx Cloud» enabled, as well as «Automatic Authentication» inside Configurator. | ||
- | \\ <WRAP Group> | + | The authentication can be done remotely without the need to access the server' |
- | <WRAP column half centeralign> | + | |
- | {{ :quickguide_authenticationMsg2.png?direct300 | + | \\ |
- | <WRAP centeralign> | + | <WRAP Group> <WRAP column half centeralign> |
- | </ | + | |
- | <WRAP column half centeralign> | + | |
- | {{ :quickguide_authenticationCloud.png?direct350 | + | |
- | <WRAP centeralign> | + | |
- | </ | + | |
- | </ | + | |