Help
This is the online help system of tyckr. It provides information about the available Providers, Facelets and the Security concept of tyckr.
Providers
Providers collect or compute data from different sources like device sensors, API requests, MQTT, WebSockets etc. The raw data of one or multiple providers is evaluated by an advanced Expression Parser, which output can be displayed by a facelet.
See the available Providers:
Facelets
A Face is created by combining multiple Facelets. Facelets are visual components like gauges, bars, icons, images or text, that are rendering and displaying data.
See the available Facelets:
Security
Security is a really important topic and serious concern of tyckr!
All passwords, usernames and API parameters of Providers and Facelets are considered as extremely sensitive, confidential and secret data.
The only way to ensure decent security is complete end-to-end encryption.
Editor Security Setup
A password must be setup in the Editor app in the Profile Settings. This is used for local encryption of all sensitive data. The encryption key is stored in the browser’s local storage and is only available by the logged in user.
The following states are possible:
Editor Password Status |
Description |
Not Set |
The Password has not been set up in the Editor, encryption is not possible |
Missing |
The Password has not set on THIS Browser, enter the same Password as on the other devices. |
Invalid |
The Password does not match the not match the Passwords on the server / other devices, enter the same Password as on the other devices. |
Valid |
Password is setup correctly, data encryption is possible |
When the password is valid in the Editor, data encryption is available and a green lock is displayed on every field which is stored encrypted:
Device Setup
The same password must be setup on every device in Settings/Configuration.
The password is stored encrypted on the device and is used to decrypt passwords, usernames and API parameters at runtime.
The following states are possible:
Device Password Status |
Description |
Not set in Editor |
The Password has not been set up in the Editor |
Not Set |
The Password has not been set up on the device |
Invalid |
The Password does not match the Editor password, data decryption is not possible |
Valid |
Editor and device password match, data decryption is possible |
Device Info
On some devices certain Providers did not gave any results, so we wanted to know why. In all cases, the answer was simple: The according sensor just did not exist.
So, the Device Info (Settings/Device Info) Page was invented. It gives all information about the available sensors, the system and the environment.
Check this page first, if you don’t get any results from a Provider (e.g. the Orientation Provider).
