user_manual

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
Last revisionBoth sides next revision
user_manual [2021/04/16 08:19] – ingriduser_manual [2022/12/13 13:20] – [Table of Content] ingrid
Line 1: Line 1:
 ====== End User Manual ====== ====== End User Manual ======
-Click [[http://www.thinknx.com/wiki/doku.php?id=user_manual&do=export_pdf|here]] to download the manual as PDF.+Click [[https://www.thinknx.com/wiki/doku.php?id=user_manual&do=export_pdf|here]] to download the manual as PDF.
 ===== Table of Content ===== ===== Table of Content =====
  
Line 13: Line 13:
       * [[user_manual#2.2.3._delete_a_project| 2.2.3. Delete a Project]]       * [[user_manual#2.2.3._delete_a_project| 2.2.3. Delete a Project]]
       * [[user_manual#2.2.4._general_settings| 2.2.4. General Settings]]       * [[user_manual#2.2.4._general_settings| 2.2.4. General Settings]]
 +      * [[user_manual#2.2.5._advanced_user_settings| 2.2.5. Advanced User Settings]]
   * [[user_manual#3._General_functions|3. General Functions]]   * [[user_manual#3._General_functions|3. General Functions]]
     * [[user_manual#3.1._Lighting|3.1. Lighting]]     * [[user_manual#3.1._Lighting|3.1. Lighting]]
Line 31: Line 32:
 </WRAP> </WRAP>
 <WRAP column half> <WRAP column half>
-<WRAP centeralign>{{ :thinknxup_devices.jpg?direct500 | Thinknx Products}} </WRAP>+<WRAP centeralign>{{ :thinknxup_products.png?direct500 | Thinknx Products}} </WRAP>
 <WRAP center 60%> <WRAP centeralign> Figure 1: Thinknx Products</WRAP>  </WRAP> <WRAP center 60%> <WRAP centeralign> Figure 1: Thinknx Products</WRAP>  </WRAP>
 </WRAP> </WRAP>
Line 61: Line 62:
 <WRAP center 60%><WRAP centeralign> Figure 3: Access to Settings </WRAP> </WRAP> <WRAP center 60%><WRAP centeralign> Figure 3: Access to Settings </WRAP> </WRAP>
  
-The settings page consists of the project lists located to the left, and the settings tab located to the right. +The settings page consists of the projects list located to the left, and the general settings of the project located to the right. These settings will allow the user to modify the appearance, change volumes, language and even update firmware if applicable. 
-{{ :usermanual_settings5.png?direct500 |Settings Interface}}+At the bottom of the page, multiple buttons are available to download a new project onto the client device using different methods (locally, through serial number and Cloud password, or using a QR code, if applicable). 
 +{{ :usermanual_newSettings2.jpg?direct500 |Settings Interface}}
 <WRAP center 60%> <WRAP centeralign> Figure 4: Settings Interface </WRAP></WRAP> <WRAP center 60%> <WRAP centeralign> Figure 4: Settings Interface </WRAP></WRAP>
- 
-There are three tabs in the settings toolbar as seen in the picture below: 
-  * **Tab 1** is used by the integrator to deploy the project on the local network. 
-  * **Tab 2** is used to download the project from Thinknx Cloud. 
-  * **Tab 3** gives access to the general settings of the project, appearance, audio, and firmware update. 
- 
-{{ :usermanual_settings_3.png?direct700 |Settings Toolbar}} 
- <WRAP center 60%> <WRAP centeralign> Figure 5: Settings Toolbar </WRAP></WRAP> 
  
 === 2.2.1. Add a Project === === 2.2.1. Add a Project ===
Line 90: Line 84:
 <WRAP centeralign>{{ :pro_man_-_client_authentication.png?direct&500 |Client Authentication 1}}</WRAP> <WRAP centeralign>{{ :pro_man_-_client_authentication.png?direct&500 |Client Authentication 1}}</WRAP>
 <WRAP centeralign> Figure 9: Client Authentication 1 </WRAP> <WRAP centeralign> Figure 9: Client Authentication 1 </WRAP>
-  * **Using Thinknx Cloud** If the project has been downloaded from Thinknx cloud by the client, he will be prompted for a username and password the very first time he tries to open the project. Both username and password shall be provided by the installer, though his presence is not necessary on site. +  * **Using Thinknx Cloud** When the project has been downloaded from Thinknx cloud by the client, they will be prompted for a username and password the very first time they attempt to open the project. Both username and password shall be provided by the installer. 
-<WRAP centeralign>{{ :quickguide_authenticationMsg2.png?direct&500 |Client Authentication 2}}</WRAP>+<WRAP centeralign>{{ :authentication_credentials.png?direct&500 |Client Authentication 2}}</WRAP>
 <WRAP centeralign> Figure 10: Client Authentication 2 </WRAP> <WRAP centeralign> Figure 10: Client Authentication 2 </WRAP>
 +  * **Using OTP** Another way to authenticate when the project has been downloaded from the Cloud is by entering a one-time password (OTP) generated by the admin user. The popup window can be toggled to enter the OTP, which is valid to be used for 2 hours only.
 +<WRAP centeralign>{{ :authentication_otp.png?direct&500 |Client Authentication 3}}</WRAP>
 +<WRAP centeralign> Figure 11: Client Authentication 3 </WRAP>
 +
 === 2.2.3. Delete a Project === === 2.2.3. Delete a Project ===
 To delete a project, slide project name to the left and click on “Delete”. To delete a project, slide project name to the left and click on “Delete”.
-<WRAP centeralign>{{ :usermanual_settings6.png?direct500 |Settings Interface}}</WRAP> +<WRAP centeralign>{{ :usermanual_deleteProject.jpg?direct500 |Settings Interface}}</WRAP> 
-<WRAP center 60%> <WRAP centeralign> Figure 11: Settings Interface </WRAP></WRAP>+<WRAP center 60%> <WRAP centeralign> Figure 12: Settings Interface </WRAP></WRAP>
  
 === 2.2.4. General Settings === === 2.2.4. General Settings ===
Line 104: Line 102:
   * **Enable geolocalization** If the user is managing more than one project (multiple houses), it is possible to automatically switch from one project to another by enabling the geolocalization. The nearest project is suggested based on the current location of the user.   * **Enable geolocalization** If the user is managing more than one project (multiple houses), it is possible to automatically switch from one project to another by enabling the geolocalization. The nearest project is suggested based on the current location of the user.
   * **Search for local server** When enabled, Thinknx will try to connect to the local IP address of the server before it attempts to connect through the Internet. It is useful when the client is inside the house and not accessing the project remotely.    * **Search for local server** When enabled, Thinknx will try to connect to the local IP address of the server before it attempts to connect through the Internet. It is useful when the client is inside the house and not accessing the project remotely. 
 +<WRAP tip center round 80%> By leaving "Search for local server" unchecked, the app will always be able to automatically detect if the client is connecting locally or remotely. It is only used in some cases where local connection is not established, but might cause delays when attempting to connect remotely without removing the option. </WRAP>
   * **Always ask which project to open at startup** in case multiple projects are managed by the user.   * **Always ask which project to open at startup** in case multiple projects are managed by the user.
   * **Open the projects in DEMO mode** When enabled, the client will not establish a connection with the server and the project will open as DEMO.   * **Open the projects in DEMO mode** When enabled, the client will not establish a connection with the server and the project will open as DEMO.
 {{ :usermanual_settings4.png?direct500 |General Settings}} {{ :usermanual_settings4.png?direct500 |General Settings}}
-<WRAP center 60%> <WRAP centeralign> Figure 12: General Settings </WRAP></WRAP>+<WRAP center 60%> <WRAP centeralign> Figure 13: General Settings </WRAP></WRAP> 
 + 
 +=== 2.2.5. Advanced User Settings === 
 +<WRAP centeralign>{{ :usermanual_advanced_settings.png?direct&700 |Advanced Settings}}</WRAP> 
 +<WRAP centeralign> Figure 14: Advanced Settings</WRAP> 
 + 
 +When the client using the Thinknx UP application is configured to be Admin by the integrator, additional functions can be unlocked by accessing the Advanced Settings window: 
 +  * **Change project language**: permits to change the project into another language, as configured inside the Configurator. The change applies on the local device only. 
 +  * **Share project**: permits to generate a QR code to share with other users wanting to download the project. 
 +  * **Manage Clients**: permits to view and manage all the clients already authenticated with the server. The administrator can delete, add, and edit the users. Users can also be temporarily deactivated, or only allowed to access the application within a pre-defined time slot. 
 +<WRAP centeralign>{{ :usermanual_manage_users.png?direct&500 |Manage Clients}}</WRAP> 
 +<WRAP centeralign> Figure 15: Manage Clients</WRAP> 
 + 
 +  * **Manage Passwords**: permits to change the different passwords used inside the project, for example, the password for cameras, intercom, etc. The new passwords set will be used instead of the ones configured inside the configurator and uploaded to the server and clients. The new passwords will not be replaced on each upload.
  
 <pagebreak> <pagebreak>
Line 152: Line 164:
 When using the RGB button, clicking on the settings icon at the bottom right corner of the popup will open an additional window. The user can save their favorite colors by clicking the “+” button. The start button will play a sequence of the saved colors. When using the RGB button, clicking on the settings icon at the bottom right corner of the popup will open an additional window. The user can save their favorite colors by clicking the “+” button. The start button will play a sequence of the saved colors.
 It is possible to select between random/ordered playing mode, and change the time interval between the colors during the sequence. It is possible to select between random/ordered playing mode, and change the time interval between the colors during the sequence.
 +
 +To delete the preset colors, simply long press on any of the presets. An X icon will show on all presets allowing the user to select the colors to be deleted.
  
 <WRAP centeralign>{{ :usermanual_light6.png?direct500 |RGB Settings}}</WRAP> <WRAP centeralign>{{ :usermanual_light6.png?direct500 |RGB Settings}}</WRAP>
  • user_manual.txt
  • Last modified: 2022/12/13 13:22
  • by ingrid