quickguide

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
quickguide [2019/10/17 09:35] – [Step 4. Creating The First Project] ingridquickguide [2024/04/10 14:21] (current) francesco
Line 1: Line 1:
 ====== Thinknx Quick Guide ====== ====== Thinknx Quick Guide ======
  
-[[quickguide#step_1_downloading_the_software|Step 1. Downloading The Software]]+[[:quickguide#step_1_downloading_the_software|Step 1. Downloading The Software]]
  
-[[quickguide#step_2_choosing_the_right_thinknx_Server|Step 2. Choosing The Right Thinknx Server]] +[[:quickguide#step_2_choosing_the_right_thinknx_server|Step 2. Choosing The Right Thinknx Server]]
  
-[[quickguide#step_3_setting_up_the_server|Step 3. Setting Up The Server]] +[[:quickguide#step_3_setting_up_the_server|Step 3. Setting Up The Server]]
  
-[[quickguide#step_4_creating_the_first_project|Step 4. Creating The First Project]]+[[:quickguide#step_4_creating_the_first_project|Step 4. Creating The First Project]]
  
-[[quickguide#step_5_deploying_the_project|Step 5. Deploying The Project ]]  +[[:quickguide#step_5_deploying_the_project|Step 5. Deploying The Project ]]
- +
-[[quickguide#step_6_authenticating_clients|Step 6. Authenticating Clients]] +
  
 +[[:quickguide#step_6_authenticating_clients|Step 6. Authenticating Clients]]
  
 <pagebreak> <pagebreak>
  
- ==== Step 1. Downloading The Software ==== +==== Step 1. Downloading The Software ==== 
-{{ :quickguide_configurator.jpg?direct |Thinknx Configurator}} + 
-<WRAP center 60%> <WRAP centeralign> Figure 1.1: Thinknx Configurator </WRAP>  </WRAP> +{{  :quickguide_configurator.jpg?direct&  |Thinknx Configurator}}<WRAP center 60%> <WRAP centeralign> Figure 1.1: Thinknx Configurator </WRAP> </WRAP> 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 [[https://www.thinknx.com/v4/en/downloads.html|here]].
-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://www.thinknx.com/v3/en/downloads.html|here]].+
  
 System requirements for Thinknx UP Configurator: System requirements for Thinknx UP Configurator:
-  * Microsoft Windows 7 or above + 
-  * 64-bit system +* * * Microsoft Windows 7 or above * * * * 64-bit system * * * * Updated graphic card driver supporting DirectX 10
-  * Updated graphic card driver supporting DirectX 10+
  
 For project visualization, Thinknx UP Client is also available for download: For project visualization, Thinknx UP Client is also available for download:
-  * Apple - [[https://itunes.apple.com/it/app/thinknx-up/id1345364297?l=en&mt=8|Download App]] 
-  * Android - [[https://play.google.com/store/apps/details?id=com.thinknx.thinknxnew| Download App]] 
-  * Windows - [[http://www.pulsareng.it/thinknx/ThinknxUpPlayer1038.zip| Download Player]] 
-  * Mac - [[http://www.pulsareng.it/thinknx/ThinknxPlayerMac1200.zip| Download Player]] 
  
-<WRAP round important center 80%> ThinKnx Player for Mac is an Air application, thus to be installed on Mac computers it requires Adobe Air software installed. Adobe Air sotfware can be found at https://get.adobe.com/air/. </WRAP> +* * * Apple - [[https://itunes.apple.com/it/app/thinknx-up/id1345364297?l=en&mt=8|Download App]] * * * * Android - [[https://play.google.com/store/apps/details?id=com.thinknx.thinknxnew| Download App]] * * * * Windows - [[https://www.thinknx.com/v4/en/downloads.html| Download Player]] * * * * Mac - [[http://www.pulsareng.it/thinknx/ThinknxPlayerMac1200.zip| Download Player]]
-<pagebreak> +
- ==== Step 2. Choosing The Right Thinknx Server ===+
-<WRAP Group><WRAP column half> +
-Thinknx provides different types of product: +
-  * **Thinknx Server** +
-    * Micro Micro Zwave +
-    * Compact +
-    * Rack +
-    * Envision Touch Screen Envision Touch Screen with Zwave +
-    Brickbox +
-  * **Thinknx Client**  +
-    Envision Client Touch Screen +
-  * **Thinknx Multiroom Audio System** +
-    * Audiofy P1 +
-    * Audiofy P4  +
-</WRAP> +
-<WRAP column half> +
-<WRAP centeralign>{{ :quickguide_servers.png?direct500 |Thinknx Servers}}</WRAP> +
-<WRAP centeralign> Figure 2.1: Thinknx Servers </WRAP> +
-</WRAP></WRAP>+
  
-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 Zwave systems).Therefore, it is always recommended to consult the licensing table below prior making any Thinknx purchase.+<WRAP round important center 80%> ThinKnx Player for Mac is an Air application, thus to be installed on Mac computers it requires Adobe Air software installed. Adobe Air sotfware can be found at [[https://get.adobe.com/air/|https://get.adobe.com/air/]]</WRAP> <pagebreak>
  
-<WRAP centeralign>{{ :quickguide_licensing_table.jpg? |Thinknx Configurator }}</WRAP> +==== Step 2. Choosing The Right Thinknx Server ==== 
-<WRAP centeralign> Figure 2.2: Thinknx Servers Licensing Table </WRAP>+ 
 +<WRAP Group><WRAP column half>\\ 
 +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: * * * **<color #6e99c7> Micro_20 / Micro DIN </color>** * * * * **<color #6e99c7>Compact_20 / Compact DIN </color>** * * * * **<color #6e99c7>Rack</color>** * * * * **<color #6e99c7>Envision_20 Touch Screen (7", 7" Retrofit, 10") </color>** * * * * **<color #6e99c7>Envision_20 Client Touch Screen (7", 7" Retrofit, 10") </color>** * * * **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>K</color> ** * * * * **<color #6e99c7>K2</color> ** * * * * **<color #6e99c7>Piccolo</color> ** * * * **Universal Modular KNX Gateway** * * * **<color #6e99c7>Brickbox</color> ** * * * **Thinknx Multiroom Audio System** * * * **<color #6e99c7>Audiofy P1</color> ** * * * * **<color #6e99c7>Audiofy P4 </color> ** * * * * ** <color #6e99c7>Audiofy expansion E4 </color>** 
 + 
 +</WRAP> <WRAP column half> <WRAP centeralign>{{  :quickguide_productline_new.png?direct&400  |Thinknx Servers}}</WRAP> <WRAP centeralign> Figure 2.1: Thinknx Product Line </WRAP> </WRAP></WRAP> 
 + 
 +\\ 
 +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, it is always recommended to consult the licensing table below prior making any Thinknx purchase. 
 + 
 +<WRAP centeralign>{{  :quickguide_licensing_table_2022.png?direct&650  |Licensing Table}}</WRAP> <WRAP centeralign> Figure 2.2: Thinknx Servers Licensing Table </WRAP>
  
 <pagebreak> <pagebreak>
 +
 ==== 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.  
  
-<WRAP centeralign>{{ :quickguide_servers.png?direct500 |Thinknx servers}} </WRAP> +**Step 3.1. Connect Server to Network and Power** \\ 
-<WRAP centeralign> Figure 3.1: Thinknx Servers </WRAP>+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. <WRAP tip round center 80%When installing Envision, we usually suggest to mount the power supply behind the screen to keep the cable as short as possible.\\ 
 +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's output by raising the voltage at maximum, to compensate the voltage drops over the cables.</WRAP>
  
-\\ **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> 
 \\ \\
-<WRAP centeralign>{{ :quickguide_scanning.png?direct500 |Server scanning}}</WRAP> +**Step 3.2. Scan for Available Servers** \\ 
-<WRAP centeralign> Figure 3.2: Server Scanning </WRAP>+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> 
 + 
 +<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://www.thinknx.com/api/myIPs.php|https://www.thinknx.com/api/myIPs.php]] </WRAP>\\ 
 +<WRAP centeralign>{{  :quickguide_scanning.png?direct&500  |Server scanning}}</WRAP> <WRAP centeralign> Figure 3.2: Server Scanning </WRAP>
  
-\\ **Step 3.3. Access Web Interface** 
-\\ Access to web interface can be done by clicking on the "Open Server Webpages" in the scanner tool, or by inputting the following path into the web browser: http://[server_IP_address]:5051 
 \\ \\
-At the login page, the following credentials must be used: <wrap hi>username=service </wrap>, <wrap hi>password=password </wrap>. It will then be requested to change the password for the next access. +**Step 3.3. Access Web Interface** \\ 
 +Access to web interface can be done by clicking on the "Open Server Webpages" in the scanner tool, or by inputting the following path into the web browser: [[http://[server_IP_address]:5051|http://[server_IP_address]:5051]]\\ 
 +At the login page, the following credentials must be used: <wrap hi>username=service </wrap>, <wrap hi>password=password </wrap>. It will then be requested to change the password for the next access.\\ 
 +<WRAP centeralign>{{  :quickguide_webpage.png?direct&500  |Thinknx web interface}}</WRAP> <WRAP centeralign> Figure 3.3: Thinknx Web Interface </WRAP> 
 \\ \\
-<WRAP centeralign>{{ :quickguide_webpage.png?direct500 |Thinknx web interface}}</WRAP> +**Step 3.4. Update Firmware to Latest Version** \\ 
-<WRAP centeralign> Figure 3.3Thinknx Web Interface </WRAP>+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 "Server" Tab, select "Updates" from the list, and click on the button "Verify for updates". If a newer version is found, click to download and install. Once finished, the server will reboot automatically.\\ 
 +<WRAP centeralign>{{  :quickguide_fwupdate.png?direct&500  |Server update}}</WRAP> <WRAP centeralign> Figure 3.4Server Update </WRAP>
  
-\\ **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 "Server" Tab, select "Updates" from the list, and click on the button "Verify for updates". If a newer version is found, click to download and install. Once finished, the server will reboot automatically. 
 \\ \\
-<WRAP centeralign>{{ :quickguide_fwupdate.png?direct500 |Server update}}</WRAP> +**Step 3.5. Fix Date and Time** \\ 
-<WRAP centeralign> Figure 3.4Server Update </WRAP>+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 "Server" tab, select "Date and Time" from the list, choose the right time zone, and click on "Save Changes". Wait for the "Operation Completed" message before going to the next step.\\ 
 +<WRAP centeralign>{{  :quickguide_time_date.png?direct&500  |Date and time configuration}}</WRAP> <WRAP centeralign> Figure 3.5Date and Time Configuration</WRAP>
  
-\\ **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 Timego to "Server" tab, select "Date and Time" from the list, choose the right time zone, and click on "Save Changes"Wait for the "Operation Completed" message before going to the next step. +**Step 3.6. Configure IP Address** \\ 
-\\ +All Thinknx Servers areby 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.\\ 
-<WRAP centeralign>{{ :quickguide_time_date.png?direct500 |Date and time configuration}}</WRAP> +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> Figure 3.5Date and Time Configuration</WRAP>+To enter a fixed IP address into the server, click on the "Server" tab, select "Network" from the list, disable "DHCP" option, enter the IP address manually along with the subnet mask, default gateway and DNS server, and click on "Save Changes".\\ 
 +To access the server's web interface again, enter the new fixed IP address in the following path: [[http://new_ip_address:5051|http://new_ip_address:5051]].\\ 
 +<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/30. </WRAP> <WRAP centeralign>{{  :quickguide_ipaddress.png?direct&500  |IP address configuration}}</WRAP> <WRAP centeralign> Figure 3.6IP Address Configuration </WRAP> <pagebreak>
  
-\\ **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 "Server" tab, select "Network" from the list, disable "DHCP" option, enter the IP address manually along with the subnet mask, default gateway and DNS server, and click on "Save Changes". 
-\\ To access the server's web interface again, enter the new fixed IP address in the following path: http://new_ip_address:5051. 
-\\ <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/30. </WRAP> 
-<WRAP centeralign>{{ :quickguide_ipaddress.png?direct500 |IP address configuration}}</WRAP> 
-<WRAP centeralign> Figure 3.6: IP Address Configuration </WRAP> 
-<pagebreak> 
 ==== 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>{{ :quickguide_wizard-1.png?direct700 |New project wizard}} </WRAP> +Projects can be created using a dedicated wizard tool, which will be automatically launched by clicking on the “New” button.\\ 
-\\ <WRAP centeralign> Figure 4.1: New Project Wizard </WRAP>+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>{{  :quickguide_wizard-1.png?direct&700  |New project wizard}}</WRAP>\\ 
 +<WRAP centeralign> Figure 4.1: New Project Wizard </WRAP>
  
 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>{{ :quickguide_system.png?direct700 |Project system information}} </WRAP> +\\ 
-\\ <WRAP centeralign> Figure 4.2: Project System Information </WRAP>+<WRAP centeralign>{{  :quickguide_system.png?direct&700  |Project system information}}</WRAP>\\ 
 +<WRAP centeralign> Figure 4.2: Project System Information </WRAP>
  
-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/Disabling **functions** (located in a menu to the left) +
-  * 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/Disabling **functions** (located in a menu to the left) * * * * 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 column half> +
-<WRAP centeralign>{{ :quickguide_addingElementInterface.png?direct500 |Designing user interface}}</WRAP> +
-\\ <WRAP centeralign> Figure 4.3Designing User Interface </WRAP> +
-</WRAP> +
-<WRAP column half> +
-<WRAP centeralign>{{ :quickguide_addingElementSystem.png?direct500 |Creating system objects}}</WRAP> +
-\\ <WRAP centeralign> Figure 4.4Creating System Objects </WRAP> +
-</WRAP> +
-</WRAP>+
  
-\\ <WRAP tip center round 80%> It is always recommended to save the project inside the Configurator, and to create a backup of the file by clicking on Export -> Export Project. </WRAP> +\\ 
-<WRAP centeralign>{{ :quickguide_save.png?direct800 |Saving and exporting project}} </WRAP> +<WRAP group> <WRAP column half> <WRAP centeralign>{{  :quickguide_addingelementinterface.png?direct&500  |Designing user interface}}</WRAP>\\ 
-<WRAP centeralign> Figure 4.5: Saving and Exporting Project </WRAP> +<WRAP centeralign> Figure 4.3: Designing User Interface </WRAP> </WRAP> <WRAP column half> <WRAP centeralign>{{  :quickguide_addingelementsystem.png?direct&500  |Creating system objects}}</WRAP>\\ 
 +<WRAP centeralign> Figure 4.4: Creating System Objects </WRAP> </WRAP> </WRAP> 
 + 
 +\\ 
 +<WRAP tip center round 80%> It is always recommended to save the project inside the Configurator, and to create a backup of the file by clicking on Export → Export Project. </WRAP> <WRAP centeralign>{{  :quickguide_save.png?direct&800  |Saving and exporting project}}</WRAP> <WRAP centeralign> Figure 4.5: Saving and Exporting Project </WRAP>
  
 <pagebreak> <pagebreak>
 +
 ==== 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's configuration is finished or has been modified, it needs to be deployed to the server and client, using one of these following methods: 
-  * [[quickguide#method_1:_using_the_local_network|Method 1: Using the local network]] 
-  * [[quickguide#method_2:_using_thinknx_cloud|Method 2: Using Thinknx cloud]] 
-\\  <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.</WRAP> 
  
- \\ === 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 [[:proj_deploy|Project Deployment]] page.\\ 
 +When a project's configuration is finished or has been modified, it needs to be deployed to the server and client, using one of these following methods: 
 + 
 +* * * [[:quickguide#method_1using_the_local_network|Method 1: Using the local network]] * * * * [[:quickguide#method_2using_thinknx_cloud|Method 2: Using Thinknx cloud]] 
 + 
 +\\ 
 +<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.</WRAP> 
 + 
 +=== 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.
-    * **Step 1.1: Deploying the project to the server** 
-      *  After saving the project inside the Configurator, click on "Deploy", and select "Upload to local server". After the upload is completed, the server will reboot. 
-<WRAP centeralign>{{ :quickguide_deployLocal.png?direct800 |Deploying to local server}} </WRAP> 
-<WRAP centeralign> Figure 5.1.1: Deploying to Local Server </WRAP> 
  
-    * **Step 1.2: Deploying the project to the client** +* * * **Step 1.1: Deploying the project to the server** * * * After saving the project inside the Configurator, click on "Deploy", and select "Upload to local server". After the upload is completed, the server will reboot. 
-          * 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 "Deploy" and select "Web server for Thinknx apps". In case some users have been created inside the Configurator, select the user corresponding to the client device. A message at the bottom of the Configurator will show stating that:\\  "Tablet server is running. App created for user "[username]". Write [PC_IP_address]:5050 to the settings on iPad or Android application". + 
-          * On the client device, Go to "Settings", select the tab with a PC icon related to the Configurator, write down in the Configurator URL the IP_address:5050 mentioned in the previous step and click "Download". The project will be downloaded to the client's device and the progress will show on the Configurator.+<WRAP centeralign>{{  :quickguide_deploylocal.png?direct&800  |Deploying to local server}}</WRAP> <WRAP centeralign> Figure 5.1.1: Deploying to Local Server </WRAP> 
 + 
 +* * * **Step 1.2: Deploying the project to the client** * * * 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 "Deploy" and select "Web server for Thinknx apps". In case some users have been created inside the Configurator, select the user corresponding to the client device. A message at the bottom of the Configurator will show stating that:\\ 
 +"Tablet server is running. App created for user "[username]". Write [PC_IP_address]:5050 to the settings on iPad or Android application"* * * * On the client device, Go to "Settings", select the tab with a PC icon related to the Configurator, write down in the Configurator URL the IP_address:5050 mentioned in the previous step and click "Download". The project will be downloaded to the client's device and the progress will show on the Configurator. 
 + 
 +<WRAP centeralign>{{  :quickguide_deploylocalclient.png?direct&800  |deploying to local client}}</WRAP> <WRAP centeralign> Figure 5.1.2.1: Deploying to Local Client </WRAP>\\ 
 +<WRAP Group> <WRAP column half centeralign> {{  :quickguide_deploylocalclient2.png?direct&300  |Local client settings}}<WRAP centeralign> Figure 5.1.2.2: Local Client Settings </WRAP> </WRAP> <WRAP column half centeralign> {{  :quickguide_deploylocalclient3.png?direct&300  |Configurator downloading message}}<WRAP centeralign> Figure 5.1.2.3: Configurator Downloading Message</WRAP> </WRAP> </WRAP> 
 + 
 +=== Method 2: Using Thinknx Cloud ===
  
-<WRAP centeralign>{{ :quickguide_deployLocalClient.png?direct800 |deploying to local client}} </WRAP> 
-<WRAP centeralign> Figure 5.1.2.1: Deploying to Local Client </WRAP> 
-\\ <WRAP Group> 
-<WRAP column half centeralign>  
-{{ :quickguide_deployLocalClient2.png?direct300 |Local client settings}}  
-<WRAP centeralign> Figure 5.1.2.2: Local Client Settings </WRAP>  
-</WRAP> 
-<WRAP column half centeralign>  
-{{ :quickguide_deployLocalClient3.png?direct300 |Configurator downloading message}}  
-<WRAP centeralign> Figure 5.1.2.3: Configurator Downloading Message</WRAP> 
-</WRAP> 
-</WRAP> 
- \\  === Method 2: Using Thinknx Cloud === 
 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** + 
-In the web interface of the Thinknx server, click on "Server" tab, select "Thinknx Cloud" from the list, and click on "Enable Thinknx Cloud". Fill in the new password and email address and click "Enable". The Cloud service should now be enabled, and the connection should be "available and established" as seen in the picture below. +* * * **Step 1: Enabling Thinknx Cloud on the server** 
-\\ <WRAP Group> + 
-<WRAP column half centeralign>  +In the web interface of the Thinknx server, click on "Server" tab, select "Thinknx Cloud" from the list, and click on "Enable Thinknx Cloud". Fill in the new password and email address and click "Enable". The Cloud service should now be enabled, and the connection should be "available and established" as seen in the picture below.\\ 
-{{ :quickguide_enableCloudServer.png?direct500 |Enabling cloud on server}}  +<WRAP Group> <WRAP column half centeralign> {{  :quickguide_enablecloudserver.png?direct&500  |Enabling cloud on server}}<WRAP centeralign> Figure 5.2.1.1: Enabling Cloud on server</WRAP> </WRAP> <WRAP column half centeralign> {{  :quickguide_enablecloudserver2.png?direct&360  |Cloud status}}<WRAP centeralign> Figure 5.2.1.2: Cloud status</WRAP> </WRAP> </WRAP> 
-<WRAP centeralign> Figure 5.2.1.1: Enabling Cloud on server</WRAP>  + 
-</WRAP> +* * * **Step 2: Configuring Cloud inside the Configurator** 
-<WRAP column half centeralign>  + 
-{{ :quickguide_enableCloudServer2.png?direct360 |Cloud status}}  +Open project inside Thinknx Configurator and enable Thinknx Cloud in the "System" tab. Make sure to enter the same password used in the web page.\\ 
-<WRAP centeralign> Figure 5.2.1.2: Cloud status</WRAP> +It is also important to enable **"Automatic Server update"** allowing the server to be updated automatically with every project upload to the Cloud.\\ 
-</WRAP> +Enabling **"Automatic Authentication"** will allow new users to access the mobile application without the need for an intervention on site (see section [[:quickguide#step_6_authenticating_clients|Client Authentication]] below).\\ 
-</WRAP> +Finally, selecting "Local and Cloud" for the **"Cloud Connection Policy"**, will allow the client to connect to the server using Thinknx Cloud whenever the local connection fails.\\ 
- \\  +<WRAP centeralign>{{  :quickguide_enablecloudconfig.png?direct&500  |Configuring cloud inside configurator}}</WRAP> <WRAP centeralign> Figure 5.2.2.1: Configuring Cloud inside Configurator </WRAP> 
-  * **Step 2: Configuring Cloud inside the Configurator** + 
-Open project inside Thinknx Configurator and enable Thinknx Cloud in the "System" tab. Make sure to enter the same password used in the web page.  +* * * **Step 3: Uploading the file to the Cloud** 
-\\ It is also important to enable **"Automatic Server update"** allowing the server to be updated automatically with every project upload to the Cloud. \\ Enabling **"Automatic Authentication"** will allow new users to access the mobile application without the need for an intervention on site (see section [[quickguide#Step_6._authenticating_clients|Client Authentication]] below). + 
-\\ Finally, selecting "Local and Cloud" for the **"Cloud Connection Policy"**, will allow the client to connect to the server using Thinknx Cloud whenever the local connection fails. +Inside Thinknx Configurator, click on "Deploy" and select "Upload to the Cloud". Allow 1-2 min after upload for the server to reboot. <WRAP centeralign>{{  :quickguide_deploycloud.png?direct&500  |Upload to Cloud}}</WRAP> <WRAP centeralign> Figure 5.2.3.1: Upload to Cloud </WRAP> 
-\\ <WRAP centeralign>{{ :quickguide_enableCloudConfig.png?direct500 |Configuring cloud inside configurator}} </WRAP> + 
-<WRAP centeralign> Figure 5.2.2.1: Configuring Cloud inside Configurator </WRAP> +* * * **Step 4: Downloading the project onto the client device** 
-  * **Step 3: Uploading the file to the Cloud** + 
-Inside Thinknx Configurator, click on "Deploy" and select "Upload to the Cloud". Allow 1-2 min after upload for the server to reboot. +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, then the password entered should be the password for each user.</WRAP> <WRAP centeralign>{{  :quickguide_downloadclient.png?direct&500  |Downloading project from Cloud}}</WRAP> <WRAP centeralign> Figure 5.2.4.1: Downloading project from Cloud </WRAP> <pagebreak> 
-<WRAP centeralign>{{ :quickguide_deployCloud.png?direct500 |Upload to Cloud}} </WRAP> +
-<WRAP centeralign> Figure 5.2.3.1: Upload to Cloud </WRAP> +
-  * **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, then the password entered should be the password for each user.</WRAP> +
-<WRAP centeralign>{{ :quickguide_downloadClient.png?direct500 |Downloading project from Cloud}} </WRAP> +
-<WRAP centeralign> Figure 5.2.4.1: Downloading project from Cloud </WRAP> +
-<pagebreak>+
 ==== Step 6. Authenticating Clients ==== ==== Step 6. Authenticating Clients ====
-Whenever the client uses the Thinknx application, a connection to the server is established. + 
-The first time the client opens the loaded project, the server requests an authentication of the device. +Whenever the client uses the Thinknx application, a connection to the server is established. The first time the client opens the loaded project, the server requests an authentication of the device. 
-  * **Authentication via local network:**+ 
 +* * * **Authentication via local network:** 
 This method only works if there is direct access to the server's web page. This method only works if there is direct access to the server's web page.
-    * The Client Authentication is done on the server’s web page, under Server -> Licenses & Codes. 
-    * Copy the last connected client code and paste it in the field under the table. 
-    * Click on “Add client code” and check the “Enabled” box. 
-\\ <WRAP Group> 
-<WRAP column half centeralign> {{ :quickguide_authenticationMsg.png?direct300 |Authentication request message}}  
-<WRAP centeralign> Figure 6.1: Authentication Request Message </WRAP>  
-</WRAP> 
-<WRAP column half centeralign>  
-{{ :quickguide_authenticationLocal.png?direct350 |Authentication method-1}}  
-<WRAP centeralign> Figure 6.2: Authentication Method-1</WRAP> 
-</WRAP> 
-</WRAP> 
  
-  * ** Authentication via Cloud** +* * * The Client Authentication is done on the servers web page, under Server → Licenses & Codes* * * * Copy the last connected client code and paste it in the field under the table* * * * Click on “Add client code” and check the “Enabled” box.
-The authentication can be done remotely without the need to access the server's web page. It only requires the creation of the users inside the Configurator projectThe username and password of each user shall be used to allow access to the project. +
-Another requirement is to have «Thinknx Cloud» enabled, as well as «Automatic Authentication» inside Configurator.+
  
-\\ <WRAP Group> +\\ 
-<WRAP column half centeralign>  +<WRAP Group> <WRAP column half centeralign> {{  :quickguide_authenticationmsg.png?direct&300  |Authentication request message}}<WRAP centeralign> Figure 6.1: Authentication Request Message </WRAP> </WRAP> <WRAP column half centeralign> {{  :quickguide_authenticationlocal.png?direct&350  |Authentication method-1}}<WRAP centeralign> Figure 6.2: Authentication Method-1</WRAP> </WRAP> </WRAP> 
-{{ :quickguide_authenticationMsg2.png?direct300 |Authentication request message}}  + 
-<WRAP centeralign> Figure 6.3: Authentication Request Message </WRAP>  +* * * ** Authentication via Cloud** 
-</WRAP> + 
-<WRAP column half centeralign>  +The authentication can be done remotely without the need to access the server's web page. It only requires the creation of the users inside the Configurator project. The username and password of each user shall be used to allow access to the project. Another requirement is to have «Thinknx Cloud» enabled, as well as «Automatic Authentication» inside Configurator. 
-{{ :quickguide_authenticationCloud.png?direct350 |Authentication method-2}}  + 
-<WRAP centeralign> Figure 6.4: Authentication Method-2</WRAP> +\\ 
-</WRAP> +<WRAP Group> <WRAP column half centeralign> {{  :quickguide_authenticationmsg2.png?direct&300  |Authentication request message}}<WRAP centeralign> Figure 6.3: Authentication Request Message </WRAP> </WRAP> <WRAP column half centeralign> {{  :quickguide_authenticationcloud.png?direct&350  |Authentication method-2}}<WRAP centeralign> Figure 6.4: Authentication Method-2</WRAP> </WRAP> </WRAP>
-</WRAP>+
  
  
  • quickguide.1571297722.txt.gz
  • Last modified: 2019/10/17 09:35
  • by ingrid