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 diff --git a/en-product/web-dashboard.md b/en-product/web-dashboard.md index 6502fd1..7d1d2c4 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](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) diff --git a/en-product/dashboard/chart.md b/en-product/web-dashboard/dashboard-chart.md similarity index 100% rename from en-product/dashboard/chart.md rename to en-product/web-dashboard/dashboard-chart.md diff --git a/en-product/web-dashboard/dashboard-label.md b/en-product/web-dashboard/dashboard-label.md new file mode 100644 index 0000000..80605e8 --- /dev/null +++ b/en-product/web-dashboard/dashboard-label.md @@ -0,0 +1,27 @@ + + 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; +- **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 + - **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 switching **Show level** on to visualize accordingly to values set in **MIN and MAX Value** fields below. diff --git a/en-product/web-dashboard/dashboard-map.md b/en-product/web-dashboard/dashboard-map.md new file mode 100644 index 0000000..d9b590b --- /dev/null +++ b/en-product/web-dashboard/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. diff --git a/en-product/web-dashboard/dashboard-slider.md b/en-product/web-dashboard/dashboard-slider.md new file mode 100644 index 0000000..f8b9490 --- /dev/null +++ b/en-product/web-dashboard/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. diff --git a/en-product/web-dashboard/dashboard-switch.md b/en-product/web-dashboard/dashboard-switch.md new file mode 100644 index 0000000..3b47497 --- /dev/null +++ b/en-product/web-dashboard/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; +- **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; +- the last option: it's possible to **Hide widget name**.