From d3e022c465fd217308e2a56c9132481481f2df31 Mon Sep 17 00:00:00 2001 From: Mark <67413917+Mark-Pan@users.noreply.github.com> Date: Wed, 9 Dec 2020 18:11:18 +0200 Subject: [PATCH 01/21] Create label Label Widget setup description. --- en-product/dashboard/label.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 en-product/dashboard/label.md diff --git a/en-product/dashboard/label.md b/en-product/dashboard/label.md new file mode 100644 index 0000000..51125bf --- /dev/null +++ b/en-product/dashboard/label.md @@ -0,0 +1,25 @@ + + Label is used to show value of Virtual Pin e.g. length/distance, mass, duration, volume, temperature and other data types including strings. + + SETUP: +- **Label** – name a Label widget so you or your client understand what it's about +- **Source** – there are two fields: + - **Choose Source** contains ***Datastreams used in the Product***. Select one; + - the left is ***Source agregation type menu*** it's used to select an option to be viewed: + **AVG of** will plot average value per minute; + **Raw of** data will plot using all the data available; + **SUM of** will summarize all incoming values to the specified Virtual Pin; + **MIN of** will plot minimum value per minute; + **MAX of** will plot maximum value per minute; + **COUNT of** will plot the number of times data was sent by device per minute; +- **Background** + - disabled **Change color based on value**: + - **Background** – pick a color for Label widget background from palette or define it by color number input + - **Text** – same here; + - enabled **Change color based on value**: + - set **MIN** and **MAX** values and Background and Font colors (as it's described in previous paragraph); + - **CUSTOM TEXT (OPTIONAL)** – value can be replaced by any text message up to 200 characters (be sure to set corresponding Label widget size); + - default set is of 3 options and it can be changed in range from 1 to as much as you need: + - click **+** button under the last MIN field to ***increase*** set; + - hover to the right from CUSTOM TEXT field, ***Delete*** button will appear; +- **Level** – enable it by turn on **Show level** switch to visualize accordingly to values set in **MIN and MAX Value** fields below. From 8d9621bc4fd0d17951169269fa5e2592a5fe14a6 Mon Sep 17 00:00:00 2001 From: Mark <67413917+Mark-Pan@users.noreply.github.com> Date: Wed, 9 Dec 2020 18:24:11 +0200 Subject: [PATCH 02/21] Update label.md --- en-product/dashboard/label.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/en-product/dashboard/label.md b/en-product/dashboard/label.md index 51125bf..55fed65 100644 --- a/en-product/dashboard/label.md +++ b/en-product/dashboard/label.md @@ -12,6 +12,8 @@ **MIN of** will plot minimum value per minute; **MAX of** will plot maximum value per minute; **COUNT of** will plot the number of times data was sent by device per minute; +- **SUFFIX** – inches, lbs, oz, minutes, °F, etc., that will be shown after the value; +- **TEXT ALIGNMENT** – 3 options are available: Left, Center, Right; - **Background** - disabled **Change color based on value**: - **Background** – pick a color for Label widget background from palette or define it by color number input From 79cb09ee1d3c6ceac88c846869dd8faa338021dd Mon Sep 17 00:00:00 2001 From: Mark <67413917+Mark-Pan@users.noreply.github.com> Date: Wed, 9 Dec 2020 18:29:11 +0200 Subject: [PATCH 03/21] Update label.md --- en-product/dashboard/label.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/en-product/dashboard/label.md b/en-product/dashboard/label.md index 55fed65..80605e8 100644 --- a/en-product/dashboard/label.md +++ b/en-product/dashboard/label.md @@ -24,4 +24,4 @@ - default set is of 3 options and it can be changed in range from 1 to as much as you need: - click **+** button under the last MIN field to ***increase*** set; - hover to the right from CUSTOM TEXT field, ***Delete*** button will appear; -- **Level** – enable it by turn on **Show level** switch to visualize accordingly to values set in **MIN and MAX Value** fields below. +- **Level** – enable it by switching **Show level** on to visualize accordingly to values set in **MIN and MAX Value** fields below. From 5e0604a3492b835b86cd50acb93fa338e1d36f93 Mon Sep 17 00:00:00 2001 From: Mark <67413917+Mark-Pan@users.noreply.github.com> Date: Fri, 11 Dec 2020 14:06:50 +0200 Subject: [PATCH 04/21] Create slider.md Slider widget setup description --- en-product/dashboard/slider.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 en-product/dashboard/slider.md diff --git a/en-product/dashboard/slider.md b/en-product/dashboard/slider.md new file mode 100644 index 0000000..09e1656 --- /dev/null +++ b/en-product/dashboard/slider.md @@ -0,0 +1,16 @@ + Slider widget allows to send values to Virtual Pin of the selected Device. + Usage examples: volume, brightness, RPM, flap position control, etc. + + + SETUP: +- Name the Slider widget by editing **Slider** inside top field; +- **Choose Source** – select Datastream; + - **Min** and **Max** – will be automatically taken from selected Datastream default value; + - **Send values on release only (optimal)** – we recommend to use this option to avoid misclick-like issues and decrease traffic to/from the Device (critical for GSM connection); +- **Steps** + - **Step** – defines value change per one slider step, e.g. 20° per 1 slider move; + - **Show fine controls** – adds - and + buttons to operate the slider; + - **Fine Control Step** – defines value change per one fine control button click, e.g. 5° per click; +- **Value** + - **Value position** – left or right side to the Slider; + - **Suffix** – type the unit you want to be viewed near the value. From a7e4fd7554ab0bb115adf0b6c1dbdaa31788fcbd Mon Sep 17 00:00:00 2001 From: Mark <67413917+Mark-Pan@users.noreply.github.com> Date: Fri, 11 Dec 2020 16:14:25 +0200 Subject: [PATCH 05/21] Create switch.md Switch widget setup description --- en-product/dashboard/switch.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) create mode 100644 en-product/dashboard/switch.md diff --git a/en-product/dashboard/switch.md b/en-product/dashboard/switch.md new file mode 100644 index 0000000..d8e29d3 --- /dev/null +++ b/en-product/dashboard/switch.md @@ -0,0 +1,12 @@ + Switch label allows to send commands and view binary statuses of the device, such as power ON/OFF + + +SETUP: +- Name the Switch widget by editing **Switch** inside top field; +- **Target** – access available Datastreams dropdown list by click on ***Choose Source***; +- set **ON/OFF VALUEs** in the corresponding fields; +- **SWITCH ALIGNMENT** – 2 options here: left and right; +- **COLOR** – pick a color for Switch ON status background from palette or define it by color number input; +- **Show on/off labels** – you can add labels for different Switch statuses: for each of them or both filling **ON LABEL** and/or **OFF LABEL** + - **LABEL POSITION** – 2 options here: left and right; +- the last option: it's possible to **Hide widget name**. From 88d8f07f38993b5aa18f8c62fa0fa0e5a2dd5b3e Mon Sep 17 00:00:00 2001 From: Mark <67413917+Mark-Pan@users.noreply.github.com> Date: Fri, 11 Dec 2020 16:16:52 +0200 Subject: [PATCH 06/21] Update switch.md --- en-product/dashboard/switch.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/en-product/dashboard/switch.md b/en-product/dashboard/switch.md index d8e29d3..3b47497 100644 --- a/en-product/dashboard/switch.md +++ b/en-product/dashboard/switch.md @@ -5,7 +5,7 @@ SETUP: - Name the Switch widget by editing **Switch** inside top field; - **Target** – access available Datastreams dropdown list by click on ***Choose Source***; - set **ON/OFF VALUEs** in the corresponding fields; -- **SWITCH ALIGNMENT** – 2 options here: left and right; +- **TEXT ALIGNMENT** – 2 options here: left and right; - **COLOR** – pick a color for Switch ON status background from palette or define it by color number input; - **Show on/off labels** – you can add labels for different Switch statuses: for each of them or both filling **ON LABEL** and/or **OFF LABEL** - **LABEL POSITION** – 2 options here: left and right; From 600582e02f6da3cfe05e00b7e6915043d5013b5f Mon Sep 17 00:00:00 2001 From: Mark <67413917+Mark-Pan@users.noreply.github.com> Date: Fri, 11 Dec 2020 16:47:33 +0200 Subject: [PATCH 07/21] Create map.md --- en-product/dashboard/map.md | 3 +++ 1 file changed, 3 insertions(+) create mode 100644 en-product/dashboard/map.md diff --git a/en-product/dashboard/map.md b/en-product/dashboard/map.md new file mode 100644 index 0000000..d9b590b --- /dev/null +++ b/en-product/dashboard/map.md @@ -0,0 +1,3 @@ + Map widget displays different types of data linked to GPS Datastream + +Currently in development. Will be availbale soon. From 9e5279526c51e37e75136fbeb5f52955f52325a8 Mon Sep 17 00:00:00 2001 From: Mark <67413917+Mark-Pan@users.noreply.github.com> Date: Fri, 11 Dec 2020 16:58:35 +0200 Subject: [PATCH 08/21] Rename chart.md to dashboard-chart.md --- en-product/dashboard/{chart.md => dashboard-chart.md} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename en-product/dashboard/{chart.md => dashboard-chart.md} (100%) diff --git a/en-product/dashboard/chart.md b/en-product/dashboard/dashboard-chart.md similarity index 100% rename from en-product/dashboard/chart.md rename to en-product/dashboard/dashboard-chart.md From e25f7599b4e4b3f037ea4dd3e0acf65a0af89273 Mon Sep 17 00:00:00 2001 From: Mark <67413917+Mark-Pan@users.noreply.github.com> Date: Fri, 11 Dec 2020 16:59:05 +0200 Subject: [PATCH 09/21] Rename label.md to dashboard-label.md --- en-product/dashboard/{label.md => dashboard-label.md} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename en-product/dashboard/{label.md => dashboard-label.md} (100%) diff --git a/en-product/dashboard/label.md b/en-product/dashboard/dashboard-label.md similarity index 100% rename from en-product/dashboard/label.md rename to en-product/dashboard/dashboard-label.md From 2064b36fac6d76737ca548485a7666805fe807fa Mon Sep 17 00:00:00 2001 From: Mark <67413917+Mark-Pan@users.noreply.github.com> Date: Fri, 11 Dec 2020 16:59:33 +0200 Subject: [PATCH 10/21] Rename map.md to dashboard-map.md --- en-product/dashboard/{map.md => dashboard-map.md} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename en-product/dashboard/{map.md => dashboard-map.md} (100%) diff --git a/en-product/dashboard/map.md b/en-product/dashboard/dashboard-map.md similarity index 100% rename from en-product/dashboard/map.md rename to en-product/dashboard/dashboard-map.md From 5296f683d2d8f919cffe1992edc9b26a96d419ac Mon Sep 17 00:00:00 2001 From: Mark <67413917+Mark-Pan@users.noreply.github.com> Date: Fri, 11 Dec 2020 16:59:59 +0200 Subject: [PATCH 11/21] Rename slider.md to dashboard-slider.md --- en-product/dashboard/{slider.md => dashboard-slider.md} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename en-product/dashboard/{slider.md => dashboard-slider.md} (100%) diff --git a/en-product/dashboard/slider.md b/en-product/dashboard/dashboard-slider.md similarity index 100% rename from en-product/dashboard/slider.md rename to en-product/dashboard/dashboard-slider.md From a355c1cf82a8ea5366bd8db93484716b3fd46407 Mon Sep 17 00:00:00 2001 From: Mark <67413917+Mark-Pan@users.noreply.github.com> Date: Fri, 11 Dec 2020 17:00:20 +0200 Subject: [PATCH 12/21] Rename switch.md to dashboard-switch.md --- en-product/dashboard/{switch.md => dashboard-switch.md} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename en-product/dashboard/{switch.md => dashboard-switch.md} (100%) diff --git a/en-product/dashboard/switch.md b/en-product/dashboard/dashboard-switch.md similarity index 100% rename from en-product/dashboard/switch.md rename to en-product/dashboard/dashboard-switch.md From b605cfc191aeb2998950e88fdd453e55bf7faad5 Mon Sep 17 00:00:00 2001 From: Mark <67413917+Mark-Pan@users.noreply.github.com> Date: Fri, 11 Dec 2020 17:04:22 +0200 Subject: [PATCH 13/21] Rename en-product/dashboard/dashboard-chart.md to en-product/web-dashboard/dashboard-chart.md --- en-product/{dashboard => web-dashboard}/dashboard-chart.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename en-product/{dashboard => web-dashboard}/dashboard-chart.md (100%) diff --git a/en-product/dashboard/dashboard-chart.md b/en-product/web-dashboard/dashboard-chart.md similarity index 100% rename from en-product/dashboard/dashboard-chart.md rename to en-product/web-dashboard/dashboard-chart.md From 35876c7c52de6d9da58866d840bc48153d579425 Mon Sep 17 00:00:00 2001 From: Mark <67413917+Mark-Pan@users.noreply.github.com> Date: Fri, 11 Dec 2020 17:05:32 +0200 Subject: [PATCH 14/21] Rename en-product/dashboard/dashboard-label.md to en-product/web-dashboard/dashboard-label.md --- en-product/{dashboard => web-dashboard}/dashboard-label.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename en-product/{dashboard => web-dashboard}/dashboard-label.md (100%) diff --git a/en-product/dashboard/dashboard-label.md b/en-product/web-dashboard/dashboard-label.md similarity index 100% rename from en-product/dashboard/dashboard-label.md rename to en-product/web-dashboard/dashboard-label.md From ee533256a4fade53e5a0552bbe2a839e1ccc0c6b Mon Sep 17 00:00:00 2001 From: Mark <67413917+Mark-Pan@users.noreply.github.com> Date: Fri, 11 Dec 2020 17:06:13 +0200 Subject: [PATCH 15/21] Rename en-product/dashboard/dashboard-map.md to en-product/web-dashboard/dashboard-map.md --- en-product/{dashboard => web-dashboard}/dashboard-map.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename en-product/{dashboard => web-dashboard}/dashboard-map.md (100%) diff --git a/en-product/dashboard/dashboard-map.md b/en-product/web-dashboard/dashboard-map.md similarity index 100% rename from en-product/dashboard/dashboard-map.md rename to en-product/web-dashboard/dashboard-map.md From dd9dbe537f2b4710422d5e0d88063addf4077a18 Mon Sep 17 00:00:00 2001 From: Mark <67413917+Mark-Pan@users.noreply.github.com> Date: Fri, 11 Dec 2020 17:06:46 +0200 Subject: [PATCH 16/21] Rename en-product/dashboard/dashboard-slider.md to en-product/web-dashboard/dashboard-slider.md --- en-product/{dashboard => web-dashboard}/dashboard-slider.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename en-product/{dashboard => web-dashboard}/dashboard-slider.md (100%) diff --git a/en-product/dashboard/dashboard-slider.md b/en-product/web-dashboard/dashboard-slider.md similarity index 100% rename from en-product/dashboard/dashboard-slider.md rename to en-product/web-dashboard/dashboard-slider.md From 303201d4fc5a38938c1d44b1b96fe8d54255e4ae Mon Sep 17 00:00:00 2001 From: Mark <67413917+Mark-Pan@users.noreply.github.com> Date: Fri, 11 Dec 2020 17:07:18 +0200 Subject: [PATCH 17/21] Rename en-product/dashboard/dashboard-switch.md to en-product/web-dashboard/dashboard-switch.md --- en-product/{dashboard => web-dashboard}/dashboard-switch.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename en-product/{dashboard => web-dashboard}/dashboard-switch.md (100%) diff --git a/en-product/dashboard/dashboard-switch.md b/en-product/web-dashboard/dashboard-switch.md similarity index 100% rename from en-product/dashboard/dashboard-switch.md rename to en-product/web-dashboard/dashboard-switch.md From 829733ffd619e3aa962fac2fee898206abf31b25 Mon Sep 17 00:00:00 2001 From: Mark <67413917+Mark-Pan@users.noreply.github.com> Date: Fri, 11 Dec 2020 17:22:26 +0200 Subject: [PATCH 18/21] Update web-dashboard.md --- en-product/web-dashboard.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/en-product/web-dashboard.md b/en-product/web-dashboard.md index 6502fd1..0025dbd 100644 --- a/en-product/web-dashboard.md +++ b/en-product/web-dashboard.md @@ -1,2 +1,9 @@ # Web Dashboard - +It's designed to group and visualize data of selected Datastreams in Widgets (interface modules). +Each of them performs a specific input/output function when communicating with the hardware. +There are 5 types of Widgets: + * [Slider](en-product/web-dashboard/dashboard-slider.md) + * [Switch](en-product/web-dashboard/dashboard-switch.md) + * [Label](en-product/web-dashboard/dashboard-label.md) + * [Chart](en-product/web-dashboard/dashboard-chart.md) + * [Map](en-product/web-dashboard/dashboard-map.md) From e58bb0e8bd9015c8f3021a81cd924a120011e4dc Mon Sep 17 00:00:00 2001 From: Mark <67413917+Mark-Pan@users.noreply.github.com> Date: Fri, 11 Dec 2020 17:27:42 +0200 Subject: [PATCH 19/21] Update web-dashboard.md --- en-product/web-dashboard.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/en-product/web-dashboard.md b/en-product/web-dashboard.md index 0025dbd..7d1d2c4 100644 --- a/en-product/web-dashboard.md +++ b/en-product/web-dashboard.md @@ -2,8 +2,8 @@ It's designed to group and visualize data of selected Datastreams in Widgets (interface modules). Each of them performs a specific input/output function when communicating with the hardware. There are 5 types of Widgets: - * [Slider](en-product/web-dashboard/dashboard-slider.md) - * [Switch](en-product/web-dashboard/dashboard-switch.md) - * [Label](en-product/web-dashboard/dashboard-label.md) - * [Chart](en-product/web-dashboard/dashboard-chart.md) - * [Map](en-product/web-dashboard/dashboard-map.md) + * [Slider](web-dashboard/dashboard-slider.md) + * [Switch](web-dashboard/dashboard-switch.md) + * [Label](web-dashboard/dashboard-label.md) + * [Chart](web-dashboard/dashboard-chart.md) + * [Map](web-dashboard/dashboard-map.md) From d56709bfeaa1e332e9315dfe906d86b5788af6a7 Mon Sep 17 00:00:00 2001 From: Mark <67413917+Mark-Pan@users.noreply.github.com> Date: Fri, 11 Dec 2020 17:27:46 +0200 Subject: [PATCH 20/21] Update SUMMARY.md --- SUMMARY.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/SUMMARY.md b/SUMMARY.md index 2080138..84b1030 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -33,6 +33,11 @@ * [System Events](en-product/events/events-online-offline.md) * [Events: Notifications Limit](en-product/events/events-notification-period.md) * [Web Dashboard](en-product/web-dashboard.md) + * [Web Dashboard: Slider](en-product/web-dashboard/dashboard-slider.md) + * [Web Dashboard: Switch](en-product/web-dashboard/dashboard-switch.md) + * [Web Dashboard: Label](en-product/web-dashboard/dashboard-label.md) + * [Web Dashboard: Chart](en-product/web-dashboard/dashboard-chart.md) + * [Web Dashboard: Map](en-product/web-dashboard/dashboard-map.md) * [Mobile app UI](en-product/mobile-app-ui.md) ## Firmware API From 8eb532d00e51ff7d65cffbbdacb49cbae6ab95be Mon Sep 17 00:00:00 2001 From: Mark <67413917+Mark-Pan@users.noreply.github.com> Date: Wed, 20 Jan 2021 14:31:59 +0200 Subject: [PATCH 21/21] Update dashboard-slider.md --- en-product/web-dashboard/dashboard-slider.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/en-product/web-dashboard/dashboard-slider.md b/en-product/web-dashboard/dashboard-slider.md index 09e1656..f8b9490 100644 --- a/en-product/web-dashboard/dashboard-slider.md +++ b/en-product/web-dashboard/dashboard-slider.md @@ -1,5 +1,5 @@ - Slider widget allows to send values to Virtual Pin of the selected Device. - Usage examples: volume, brightness, RPM, flap position control, etc. + Slider widget allows to send values to Virtual Pin of the selected Device. + Usage examples: volume, brightness, RPM, flap position control, etc. SETUP: