diff --git a/.gitbook/assets/Arduino_LED.jpg b/.gitbook/assets/Arduino_LED.jpg deleted file mode 100644 index b86faea..0000000 Binary files a/.gitbook/assets/Arduino_LED.jpg and /dev/null differ diff --git a/.gitbook/assets/Particle Demo1530733075.png b/.gitbook/assets/Particle Demo1530733075.png deleted file mode 100644 index 5ae7bce..0000000 Binary files a/.gitbook/assets/Particle Demo1530733075.png and /dev/null differ diff --git a/.gitbook/assets/QR.png b/.gitbook/assets/QR.png deleted file mode 100644 index 6575556..0000000 Binary files a/.gitbook/assets/QR.png and /dev/null differ diff --git a/.gitbook/assets/QR_button_edit.png b/.gitbook/assets/QR_button_edit.png deleted file mode 100644 index b95920b..0000000 Binary files a/.gitbook/assets/QR_button_edit.png and /dev/null differ diff --git a/.gitbook/assets/TwitterON.png b/.gitbook/assets/TwitterON.png deleted file mode 100644 index 8426df3..0000000 Binary files a/.gitbook/assets/TwitterON.png and /dev/null differ diff --git a/.gitbook/assets/app_connected_setting (1).png b/.gitbook/assets/app_connected_setting (1).png deleted file mode 100644 index 6b1c096..0000000 Binary files a/.gitbook/assets/app_connected_setting (1).png and /dev/null differ diff --git a/.gitbook/assets/app_connected_setting.png b/.gitbook/assets/app_connected_setting.png deleted file mode 100644 index 6b1c096..0000000 Binary files a/.gitbook/assets/app_connected_setting.png and /dev/null differ diff --git a/.gitbook/assets/appstore-lrg.svg b/.gitbook/assets/appstore-lrg.svg deleted file mode 100644 index 0fe477c..0000000 --- a/.gitbook/assets/appstore-lrg.svg +++ /dev/null @@ -1,129 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/.gitbook/assets/architecture.png b/.gitbook/assets/architecture.png deleted file mode 100644 index fbdc950..0000000 Binary files a/.gitbook/assets/architecture.png and /dev/null differ diff --git a/.gitbook/assets/binary_charts.png b/.gitbook/assets/binary_charts.png deleted file mode 100644 index 4b313f1..0000000 Binary files a/.gitbook/assets/binary_charts.png and /dev/null differ diff --git a/.gitbook/assets/binarylabel_charts.png b/.gitbook/assets/binarylabel_charts.png deleted file mode 100644 index ec5ec4d..0000000 Binary files a/.gitbook/assets/binarylabel_charts.png and /dev/null differ diff --git a/.gitbook/assets/bridge.png b/.gitbook/assets/bridge.png deleted file mode 100644 index 193808a..0000000 Binary files a/.gitbook/assets/bridge.png and /dev/null differ diff --git a/.gitbook/assets/button.png b/.gitbook/assets/button.png deleted file mode 100644 index 34cbe87..0000000 Binary files a/.gitbook/assets/button.png and /dev/null differ diff --git a/.gitbook/assets/button_edit.png b/.gitbook/assets/button_edit.png deleted file mode 100644 index 7a2ca65..0000000 Binary files a/.gitbook/assets/button_edit.png and /dev/null differ diff --git a/.gitbook/assets/button_pressed.png b/.gitbook/assets/button_pressed.png deleted file mode 100644 index 6cbe4e8..0000000 Binary files a/.gitbook/assets/button_pressed.png and /dev/null differ diff --git a/.gitbook/assets/button_settings.png b/.gitbook/assets/button_settings.png deleted file mode 100644 index d14ee91..0000000 Binary files a/.gitbook/assets/button_settings.png and /dev/null differ diff --git a/.gitbook/assets/button_virtual_1.png b/.gitbook/assets/button_virtual_1.png deleted file mode 100644 index 30b2207..0000000 Binary files a/.gitbook/assets/button_virtual_1.png and /dev/null differ diff --git a/.gitbook/assets/clone.png b/.gitbook/assets/clone.png deleted file mode 100644 index fa312b5..0000000 Binary files a/.gitbook/assets/clone.png and /dev/null differ diff --git a/.gitbook/assets/connection_type_sketch.png b/.gitbook/assets/connection_type_sketch.png deleted file mode 100644 index a0d812b..0000000 Binary files a/.gitbook/assets/connection_type_sketch.png and /dev/null differ diff --git a/.gitbook/assets/create_project_button.png b/.gitbook/assets/create_project_button.png deleted file mode 100644 index 1bb4065..0000000 Binary files a/.gitbook/assets/create_project_button.png and /dev/null differ diff --git a/.gitbook/assets/dash_public_sharing.png b/.gitbook/assets/dash_public_sharing.png deleted file mode 100644 index c0d0560..0000000 Binary files a/.gitbook/assets/dash_public_sharing.png and /dev/null differ diff --git a/.gitbook/assets/dash_settings_sharing.png b/.gitbook/assets/dash_settings_sharing.png deleted file mode 100644 index dd4336a..0000000 Binary files a/.gitbook/assets/dash_settings_sharing.png and /dev/null differ diff --git a/.gitbook/assets/dash_settings_sharing_generate.png b/.gitbook/assets/dash_settings_sharing_generate.png deleted file mode 100644 index e4c0ce9..0000000 Binary files a/.gitbook/assets/dash_settings_sharing_generate.png and /dev/null differ diff --git a/.gitbook/assets/datapoints1_charts.png b/.gitbook/assets/datapoints1_charts.png deleted file mode 100644 index 80b7b2b..0000000 Binary files a/.gitbook/assets/datapoints1_charts.png and /dev/null differ diff --git a/.gitbook/assets/datapoints2_charts.png b/.gitbook/assets/datapoints2_charts.png deleted file mode 100644 index 068d4fa..0000000 Binary files a/.gitbook/assets/datapoints2_charts.png and /dev/null differ diff --git a/.gitbook/assets/datastream_charts.png b/.gitbook/assets/datastream_charts.png deleted file mode 100644 index e50d1a0..0000000 Binary files a/.gitbook/assets/datastream_charts.png and /dev/null differ diff --git a/.gitbook/assets/display (1).png b/.gitbook/assets/display (1).png deleted file mode 100644 index 9f93fca..0000000 Binary files a/.gitbook/assets/display (1).png and /dev/null differ diff --git a/.gitbook/assets/display.png b/.gitbook/assets/display.png deleted file mode 100644 index 9f93fca..0000000 Binary files a/.gitbook/assets/display.png and /dev/null differ diff --git a/.gitbook/assets/display_edit.png b/.gitbook/assets/display_edit.png deleted file mode 100644 index b0998bb..0000000 Binary files a/.gitbook/assets/display_edit.png and /dev/null differ diff --git a/.gitbook/assets/display_edit_mapping.png b/.gitbook/assets/display_edit_mapping.png deleted file mode 100644 index 53612a4..0000000 Binary files a/.gitbook/assets/display_edit_mapping.png and /dev/null differ diff --git a/.gitbook/assets/eventor_edit.png b/.gitbook/assets/eventor_edit.png deleted file mode 100644 index c6b5f28..0000000 Binary files a/.gitbook/assets/eventor_edit.png and /dev/null differ diff --git a/.gitbook/assets/eventor_for_temp_example.png b/.gitbook/assets/eventor_for_temp_example.png deleted file mode 100644 index d8e1b03..0000000 Binary files a/.gitbook/assets/eventor_for_temp_example.png and /dev/null differ diff --git a/.gitbook/assets/frequency_reading_pull.png b/.gitbook/assets/frequency_reading_pull.png deleted file mode 100644 index bf78f40..0000000 Binary files a/.gitbook/assets/frequency_reading_pull.png and /dev/null differ diff --git a/.gitbook/assets/frequency_reading_push.png b/.gitbook/assets/frequency_reading_push.png deleted file mode 100644 index 4f5cd0f..0000000 Binary files a/.gitbook/assets/frequency_reading_push.png and /dev/null differ diff --git a/.gitbook/assets/fullscreen_charts.png b/.gitbook/assets/fullscreen_charts.png deleted file mode 100644 index 9a957f3..0000000 Binary files a/.gitbook/assets/fullscreen_charts.png and /dev/null differ diff --git a/.gitbook/assets/gauge.png b/.gitbook/assets/gauge.png deleted file mode 100644 index 9708af6..0000000 Binary files a/.gitbook/assets/gauge.png and /dev/null differ diff --git a/.gitbook/assets/gauge_edit.png b/.gitbook/assets/gauge_edit.png deleted file mode 100644 index 628e2d3..0000000 Binary files a/.gitbook/assets/gauge_edit.png and /dev/null differ diff --git a/.gitbook/assets/joystick.png b/.gitbook/assets/joystick.png deleted file mode 100644 index c8ce5ff..0000000 Binary files a/.gitbook/assets/joystick.png and /dev/null differ diff --git a/.gitbook/assets/joystick_edit.png b/.gitbook/assets/joystick_edit.png deleted file mode 100644 index 2af9c66..0000000 Binary files a/.gitbook/assets/joystick_edit.png and /dev/null differ diff --git a/.gitbook/assets/joystick_merge_mode.png b/.gitbook/assets/joystick_merge_mode.png deleted file mode 100644 index bfd35d9..0000000 Binary files a/.gitbook/assets/joystick_merge_mode.png and /dev/null differ diff --git a/.gitbook/assets/labeled_value_edit.png b/.gitbook/assets/labeled_value_edit.png deleted file mode 100644 index a6f0a5b..0000000 Binary files a/.gitbook/assets/labeled_value_edit.png and /dev/null differ diff --git a/.gitbook/assets/labeled_value_format_edit.png b/.gitbook/assets/labeled_value_format_edit.png deleted file mode 100644 index 578affb..0000000 Binary files a/.gitbook/assets/labeled_value_format_edit.png and /dev/null differ diff --git a/.gitbook/assets/lcd.png b/.gitbook/assets/lcd.png deleted file mode 100644 index f4288cb..0000000 Binary files a/.gitbook/assets/lcd.png and /dev/null differ diff --git a/.gitbook/assets/lcd_edit.png b/.gitbook/assets/lcd_edit.png deleted file mode 100644 index bb38363..0000000 Binary files a/.gitbook/assets/lcd_edit.png and /dev/null differ diff --git a/.gitbook/assets/lcd_format_edit.png b/.gitbook/assets/lcd_format_edit.png deleted file mode 100644 index 2fd2fe0..0000000 Binary files a/.gitbook/assets/lcd_format_edit.png and /dev/null differ diff --git a/.gitbook/assets/led.png b/.gitbook/assets/led.png deleted file mode 100644 index f071806..0000000 Binary files a/.gitbook/assets/led.png and /dev/null differ diff --git a/.gitbook/assets/list_of_devices.png b/.gitbook/assets/list_of_devices.png deleted file mode 100644 index a9ca153..0000000 Binary files a/.gitbook/assets/list_of_devices.png and /dev/null differ diff --git a/.gitbook/assets/mail.png b/.gitbook/assets/mail.png deleted file mode 100644 index 3fef7cc..0000000 Binary files a/.gitbook/assets/mail.png and /dev/null differ diff --git a/.gitbook/assets/menu_charts.png b/.gitbook/assets/menu_charts.png deleted file mode 100644 index 0a62930..0000000 Binary files a/.gitbook/assets/menu_charts.png and /dev/null differ diff --git a/.gitbook/assets/menu_edit.png b/.gitbook/assets/menu_edit.png deleted file mode 100644 index 6044931..0000000 Binary files a/.gitbook/assets/menu_edit.png and /dev/null differ diff --git a/.gitbook/assets/new_device (1).png b/.gitbook/assets/new_device (1).png deleted file mode 100644 index 66a01b6..0000000 Binary files a/.gitbook/assets/new_device (1).png and /dev/null differ diff --git a/.gitbook/assets/new_device.png b/.gitbook/assets/new_device.png deleted file mode 100644 index 66a01b6..0000000 Binary files a/.gitbook/assets/new_device.png and /dev/null differ diff --git a/.gitbook/assets/new_project.png b/.gitbook/assets/new_project.png deleted file mode 100644 index 2445bd2..0000000 Binary files a/.gitbook/assets/new_project.png and /dev/null differ diff --git a/.gitbook/assets/new_project_settings.png b/.gitbook/assets/new_project_settings.png deleted file mode 100644 index 921e384..0000000 Binary files a/.gitbook/assets/new_project_settings.png and /dev/null differ diff --git a/.gitbook/assets/online_status.png b/.gitbook/assets/online_status.png deleted file mode 100644 index 5c596f9..0000000 Binary files a/.gitbook/assets/online_status.png and /dev/null differ diff --git a/.gitbook/assets/pin_selection (1).png b/.gitbook/assets/pin_selection (1).png deleted file mode 100644 index c395973..0000000 Binary files a/.gitbook/assets/pin_selection (1).png and /dev/null differ diff --git a/.gitbook/assets/pin_selection.png b/.gitbook/assets/pin_selection.png deleted file mode 100644 index c395973..0000000 Binary files a/.gitbook/assets/pin_selection.png and /dev/null differ diff --git a/.gitbook/assets/play_button.png b/.gitbook/assets/play_button.png deleted file mode 100644 index 2c067be..0000000 Binary files a/.gitbook/assets/play_button.png and /dev/null differ diff --git a/.gitbook/assets/push.png b/.gitbook/assets/push.png deleted file mode 100644 index f820946..0000000 Binary files a/.gitbook/assets/push.png and /dev/null differ diff --git a/.gitbook/assets/register_account.png b/.gitbook/assets/register_account.png deleted file mode 100644 index ff18aff..0000000 Binary files a/.gitbook/assets/register_account.png and /dev/null differ diff --git a/.gitbook/assets/reset.png b/.gitbook/assets/reset.png deleted file mode 100644 index a45e6cc..0000000 Binary files a/.gitbook/assets/reset.png and /dev/null differ diff --git a/.gitbook/assets/rtc_edit.png b/.gitbook/assets/rtc_edit.png deleted file mode 100644 index 42cea49..0000000 Binary files a/.gitbook/assets/rtc_edit.png and /dev/null differ diff --git a/.gitbook/assets/scan_qr.png b/.gitbook/assets/scan_qr.png deleted file mode 100644 index 09968ba..0000000 Binary files a/.gitbook/assets/scan_qr.png and /dev/null differ diff --git a/.gitbook/assets/select_hardware.png b/.gitbook/assets/select_hardware.png deleted file mode 100644 index 9ee5a68..0000000 Binary files a/.gitbook/assets/select_hardware.png and /dev/null differ diff --git a/.gitbook/assets/slider.png b/.gitbook/assets/slider.png deleted file mode 100644 index 065c06b..0000000 Binary files a/.gitbook/assets/slider.png and /dev/null differ diff --git a/.gitbook/assets/slider_edit.png b/.gitbook/assets/slider_edit.png deleted file mode 100644 index b8cb352..0000000 Binary files a/.gitbook/assets/slider_edit.png and /dev/null differ diff --git a/.gitbook/assets/swipe_charts.png b/.gitbook/assets/swipe_charts.png deleted file mode 100644 index dd0d049..0000000 Binary files a/.gitbook/assets/swipe_charts.png and /dev/null differ diff --git a/.gitbook/assets/tabs_settings.png b/.gitbook/assets/tabs_settings.png deleted file mode 100644 index 6a6e804..0000000 Binary files a/.gitbook/assets/tabs_settings.png and /dev/null differ diff --git a/.gitbook/assets/tapnhold_charts.png b/.gitbook/assets/tapnhold_charts.png deleted file mode 100644 index 6943912..0000000 Binary files a/.gitbook/assets/tapnhold_charts.png and /dev/null differ diff --git a/.gitbook/assets/terminal.png b/.gitbook/assets/terminal.png deleted file mode 100644 index 20fd14d..0000000 Binary files a/.gitbook/assets/terminal.png and /dev/null differ diff --git a/.gitbook/assets/terminal_edit.png b/.gitbook/assets/terminal_edit.png deleted file mode 100644 index 737db39..0000000 Binary files a/.gitbook/assets/terminal_edit.png and /dev/null differ diff --git a/.gitbook/assets/timer.png b/.gitbook/assets/timer.png deleted file mode 100644 index 91d9b1f..0000000 Binary files a/.gitbook/assets/timer.png and /dev/null differ diff --git a/.gitbook/assets/timer_edit.png b/.gitbook/assets/timer_edit.png deleted file mode 100644 index ff472a6..0000000 Binary files a/.gitbook/assets/timer_edit.png and /dev/null differ diff --git a/.gitbook/assets/token_1.png b/.gitbook/assets/token_1.png deleted file mode 100644 index f734053..0000000 Binary files a/.gitbook/assets/token_1.png and /dev/null differ diff --git a/.gitbook/assets/webhook_settings.png b/.gitbook/assets/webhook_settings.png deleted file mode 100644 index 730681d..0000000 Binary files a/.gitbook/assets/webhook_settings.png and /dev/null differ diff --git a/.gitbook/assets/widget_settings_devices.png b/.gitbook/assets/widget_settings_devices.png deleted file mode 100644 index efb3eb2..0000000 Binary files a/.gitbook/assets/widget_settings_devices.png and /dev/null differ diff --git a/.gitbook/assets/widgets_box.png b/.gitbook/assets/widgets_box.png deleted file mode 100644 index 361b264..0000000 Binary files a/.gitbook/assets/widgets_box.png and /dev/null differ diff --git a/.gitbook/assets/yScale_manual_charts.png b/.gitbook/assets/yScale_manual_charts.png deleted file mode 100644 index edc0e5e..0000000 Binary files a/.gitbook/assets/yScale_manual_charts.png and /dev/null differ diff --git a/.gitbook/assets/yheight2_charts.png b/.gitbook/assets/yheight2_charts.png deleted file mode 100644 index 19f2a59..0000000 Binary files a/.gitbook/assets/yheight2_charts.png and /dev/null differ diff --git a/.gitbook/assets/yheight2_manual_charts.png b/.gitbook/assets/yheight2_manual_charts.png deleted file mode 100644 index 3efc557..0000000 Binary files a/.gitbook/assets/yheight2_manual_charts.png and /dev/null differ diff --git a/README.md b/README.md index 06c07e0..e897b41 100644 --- a/README.md +++ b/README.md @@ -4,13 +4,13 @@ description: Full documentation on Blynk 2.0 # What is Blynk -Blynk IoT Platform is a white-label, multi-tenant software solution that allows you to build personal and commercial IoT projects connected products. +Blynk IoT Platform is a white-label, multi-tenant software solution that allows you to build personal and commercial IoT projects connected products. With Blynk you can start with building a prototype or personal project and then scale it up to millions of commercial connected devices. -Blynk platform allows you to connect almost any electronics hardware to the Internet, start collectind data from devices, monitor and control them remotely from anywhere in the world +Blynk platform allows you to connect almost any electronics hardware to the Internet, start collectind data from devices, monitor and control them remotely from anywhere in the world -Data from devices can be stored, aggregated, and visualized in easy-to-build mobile and web applications. +Data from devices can be stored, aggregated, and visualized in easy-to-build mobile and web applications. Blynk is a real-time system where you can create outstanding experience for your end-customers and perform complex analytics diff --git a/SUMMARY.md b/SUMMARY.md index 7214a97..07ebfa0 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -6,34 +6,34 @@ * [Blynk Components](overview/blynk-components.md) -## Product - -* [What is a Product](product-1/create-new-product.md) -* [General Settings](product-1/general-settings/README.md) - * [Manufacturer](product-1/general-settings/product_manufacturer.md) - * [Offline Ignore Period](product-1/general-settings/product_offline_ignore_period.md) -* [Metadata](product-1/metadata.md) -* [Datastreams](product-1/datastreams/README.md) - * [Datastream Name](product-1/datastreams/datastream_name.md) - * [Decimals Formatting](product-1/datastreams/datastream_deicmals.md) - * [Wait for confirmation from the device](product-1/datastreams/datastream_feedback.md) - * [Default Value](product-1/datastreams/datastream_default_value.md) - * [Expose to Automation](product-1/datastreams/datastream_automation.md) - * [Sync with the latest server value](product-1/datastreams/datastream_sync.md) - * [Datastream: Alias](product-1/datastreams/datastream_alias.md) - * [Datastream: Invalidate Value](product-1/datastreams/datastream_invalidate.md) - * [Datastream: Min/Max values](product-1/datastreams/datastream_min_max.md) - * [Datastream: Data Type](product-1/datastreams/datastream_datatype.md) - * [Datastream: Virtual Pin](product-1/datastreams/datastream_virtual_pin.md) - * [Datastream: Save Raw Data](product-1/datastreams/datastream_save_raw.md) -* [Events](product-1/events/README.md) - * [Events: Notification](product-1/events/event_notification.md) - * [Events: Code](product-1/events/event_code.md) - * [Events: Name](product-1/events/event_name.md) - * [Events: Online, Offline](product-1/events/event_online_offline.md) - * [Events: Notification Period](product-1/events/event_notification_period.md) -* [Web Dashboard](product-1/dashboard.md) -* [Mobile app UI](product-1/product-template-settings.md) +## Product + +* [What is a Product](en-product/create-new-product.md) +* [General Settings](en-product/general-settings/README.md) + * [Manufacturer](en-product/general-settings/manufacturer.md) + * [Offline Ignore Period](en-product/general-settings/offline-ignore-period.md) +* [Metadata](en-product/metadata.md) +* [Datastreams](en-product/datastreams/README.md) + * [Datastream Name](en-product/datastreams/datastream-name.md) + * [Decimals Formatting](en-product/datastreams/decimals-formatting.md) + * [Wait for confirmation from the device](en-product/datastreams/wait-for-confirmation-from-the-device.md) + * [Default Value](en-product/datastreams/default-value.md) + * [Expose to Automation](en-product/datastreams/expose-to-automation.md) + * [Sync with the latest server value](en-product/datastreams/sync-with-the-latest-server-value.md) + * [Datastream: Alias](en-product/datastreams/datastream-alias.md) + * [Datastream: Invalidate Value](en-product/datastreams/datastream-invalidate-value.md) + * [Datastream: Min/Max values](en-product/datastreams/datastream-min-max-values.md) + * [Datastream: Data Type](en-product/datastreams/datastream-data-type.md) + * [Datastream: Virtual Pin](en-product/datastreams/datastream-virtual-pin.md) + * [Datastream: Save Raw Data](en-product/datastreams/datastream-save-raw-data.md) +* [Events](en-product/events/README.md) + * [Events: Notification](en-product/events/events-notification.md) + * [Events: Code](en-product/events/events-code.md) + * [Events: Name](en-product/events/events-name.md) + * [Events: Online, Offline](en-product/events/events-online-offline.md) + * [Events: Notifications Limit](en-product/events/events-notification-period.md) +* [Web Dashboard](en-product/web-dashboard.md) +* [Mobile app UI](en-product/mobile-app-ui.md) ## Firmware API @@ -42,9 +42,7 @@ ## REST API * [Devices](https-api/external_api.md) -* [Download Datastream Data](https-api/api_getlastweekdata.md) -* [Events API \(with responses\)](https-api/events-api-with-responses.md) -* [Events API](https-api/events-api.md) +* [Events](https-api/events-api.md) ## Mobile App diff --git a/blynk.air-ota/blynk.air-firmware-over-the-air.md b/blynk.air-ota/blynk.air-firmware-over-the-air.md new file mode 100644 index 0000000..46b7dbe --- /dev/null +++ b/blynk.air-ota/blynk.air-firmware-over-the-air.md @@ -0,0 +1,15 @@ +# Blynk.Air - Firmware Over the Air + +In this section, you can manage the firmware updates over the air. +To create the shipping, head to Blynk.Air page by pressing the corresponding icon on the main menu. + + +![Blynk.Air](../.gitbook/assets/image%20%281%29.png) + +1. Select the target product +2. Select target devices +3. Upload the firmware file +4. Press "Start Shipping" + +![](../.gitbook/assets/image%20%282%29.png) + diff --git a/device/actions-log.md b/device/actions-log.md new file mode 100644 index 0000000..2a954da --- /dev/null +++ b/device/actions-log.md @@ -0,0 +1,27 @@ +# Actions Log + +Actions logs let you to view the history of actions and events that had happened to **Devices** and **Users**. + +How to **view action logs**: +for Users: +- Settings - Organization Settings - Users \(or Search\) +- click on username +- switch to Actions log tab; + +for Devices: +- Devices tab \(or Search\) +- click on username +- switch to Actions log tab. + +Here you can **select** Actions log **view range**: + +![Actions log range](../.gitbook/assets/actlogviewrange.png) + +and watch the log: + +![Device log view](../.gitbook/assets/captured-63-.gif) + +You can **sort view order** by clicking the arrows next to the collumns names: + +![User log view order change](../.gitbook/assets/captured-62-.gif) + diff --git a/device/info.md b/device/info.md new file mode 100644 index 0000000..9692dbf --- /dev/null +++ b/device/info.md @@ -0,0 +1,18 @@ +# Info + +**Status** - Current device status \(Online/Offline\) + +**Last Online** - When the device was last seen online + +**Last Reported** - When the device last sent some data + +**Device Activated** - When and which user provisioned the device + +**Latest Metadata update** - When and which user last edited the metadata + +**Auth Token** - You can copy the auth token + +**Organization** - Current organization of the device + +**Firmware version** - Current firmware version" + diff --git a/device/metadata.md b/device/metadata.md new file mode 100644 index 0000000..196c3fc --- /dev/null +++ b/device/metadata.md @@ -0,0 +1,2 @@ +# Metadata + diff --git a/device/service.md b/device/service.md new file mode 100644 index 0000000..a45d6c6 --- /dev/null +++ b/device/service.md @@ -0,0 +1,2 @@ +# Service + diff --git a/device/tags.md b/device/tags.md new file mode 100644 index 0000000..e6e82a0 --- /dev/null +++ b/device/tags.md @@ -0,0 +1,24 @@ +# Tags + +Tags ****can be used to give a short note to selected unit. They can be applied to **Users** and **Devices** now. + +**Tags management panel** is located in Setting - Organization Settings - Tags + +![Tags management panel](../.gitbook/assets/tags-management.png) + + +Here you can create Tags with length _up to 16 characters \(only letters, digits, and spaces\)_ and pick the colors, edit and remove them. + +![Name and pick a color](../.gitbook/assets/tagcolname.png) + +There's an option to **create new tag on-the-go** in User or Device view: +- click tag icon +- start typing it's name +- press enter or "Create new tag: %tag\_name%" +_**Note:**_ the only downside of this method is no color selection. + +![New tag create in Unit's view window](../.gitbook/assets/captured-61-.gif) + +To **unassign tag** from unit just click x near tag's name. +If you need to **edit** or completely **remove** the tag follow to Tags management panel. + diff --git a/device/timeline.md b/device/timeline.md new file mode 100644 index 0000000..f202bfe --- /dev/null +++ b/device/timeline.md @@ -0,0 +1,2 @@ +# Timeline + diff --git a/device/web-dashboard/README.md b/device/web-dashboard/README.md new file mode 100644 index 0000000..3c5232d --- /dev/null +++ b/device/web-dashboard/README.md @@ -0,0 +1,4 @@ +# Dashboard + +After selecting a device, you'll see its' Dashboard - the first and most important tab. Dashboard is a set of widgets you can use to control and monitor the state of your device, check device state history or download a report for a detailed study. + diff --git a/device/web-dashboard/date-picker.md b/device/web-dashboard/date-picker.md new file mode 100644 index 0000000..b7ea44f --- /dev/null +++ b/device/web-dashboard/date-picker.md @@ -0,0 +1,8 @@ +# Time-period selection + +On the top of the Dashboard there is a time-period selection which defines what data is presented bellow. The "Current" selection means you are viewing the real time updates of the device. + +There are also 6 predefined historical periods you can select to filter data accordingly: from last hour, 6 hours, 1 day, 1 week, 1 month, 3 months. + +When the "Custom Range" is selected, you can enter your custom start and end date of the desired time range to be displayed on the Dashboard. + diff --git a/device/web-dashboard/widgets.md b/device/web-dashboard/widgets.md new file mode 100644 index 0000000..ec90191 --- /dev/null +++ b/device/web-dashboard/widgets.md @@ -0,0 +1,10 @@ +# Widgets + +Use **Switch** widget to trigger ON or OFF an action on the device. + + Drag the handler of the **Slider** widget to change the corresponding setting on the device. + + **Label** widget displays the configured piece of information, e.g. temparutate or voltage. + +The **Chart** widget is used when you want to be able to quicly check how the value was changing during the historical period. + diff --git a/en/product/create-new-product.md b/en-product/create-new-product.md similarity index 77% rename from en/product/create-new-product.md rename to en-product/create-new-product.md index 8612254..29dbdc3 100644 --- a/en/product/create-new-product.md +++ b/en-product/create-new-product.md @@ -2,5 +2,5 @@ description: How to create new Product on Blynk IoT platform --- -# Create New Product +# What is a Product diff --git a/en-product/datastreams/README.md b/en-product/datastreams/README.md new file mode 100644 index 0000000..fb98b1e --- /dev/null +++ b/en-product/datastreams/README.md @@ -0,0 +1,2 @@ +# Datastreams + diff --git a/en-product/datastreams/datastream-alias.md b/en-product/datastreams/datastream-alias.md new file mode 100644 index 0000000..0866204 --- /dev/null +++ b/en-product/datastreams/datastream-alias.md @@ -0,0 +1,2 @@ +# Datastream: Alias + diff --git a/en-product/datastreams/datastream-data-type.md b/en-product/datastreams/datastream-data-type.md new file mode 100644 index 0000000..3f2e529 --- /dev/null +++ b/en-product/datastreams/datastream-data-type.md @@ -0,0 +1,2 @@ +# Datastream: Data Type + diff --git a/en-product/datastreams/datastream-id.md b/en-product/datastreams/datastream-id.md new file mode 100644 index 0000000..6f5961c --- /dev/null +++ b/en-product/datastreams/datastream-id.md @@ -0,0 +1,2 @@ +# Datastream ID + diff --git a/en-product/datastreams/datastream-invalidate-value.md b/en-product/datastreams/datastream-invalidate-value.md new file mode 100644 index 0000000..0998910 --- /dev/null +++ b/en-product/datastreams/datastream-invalidate-value.md @@ -0,0 +1,2 @@ +# Datastream: Invalidate Value + diff --git a/en-product/datastreams/datastream-min-max-values.md b/en-product/datastreams/datastream-min-max-values.md new file mode 100644 index 0000000..1d4ca00 --- /dev/null +++ b/en-product/datastreams/datastream-min-max-values.md @@ -0,0 +1,2 @@ +# Datastream: Min/Max values + diff --git a/en-product/datastreams/datastream-name.md b/en-product/datastreams/datastream-name.md new file mode 100644 index 0000000..a0a1138 --- /dev/null +++ b/en-product/datastreams/datastream-name.md @@ -0,0 +1,2 @@ +# Datastream Name + diff --git a/en-product/datastreams/datastream-save-raw-data.md b/en-product/datastreams/datastream-save-raw-data.md new file mode 100644 index 0000000..86988a1 --- /dev/null +++ b/en-product/datastreams/datastream-save-raw-data.md @@ -0,0 +1,2 @@ +# Datastream: Save Raw Data + diff --git a/en-product/datastreams/datastream-virtual-pin.md b/en-product/datastreams/datastream-virtual-pin.md new file mode 100644 index 0000000..3a4071f --- /dev/null +++ b/en-product/datastreams/datastream-virtual-pin.md @@ -0,0 +1,2 @@ +# Datastream: Virtual Pin + diff --git a/en-product/datastreams/decimals-formatting.md b/en-product/datastreams/decimals-formatting.md new file mode 100644 index 0000000..0e17873 --- /dev/null +++ b/en-product/datastreams/decimals-formatting.md @@ -0,0 +1,2 @@ +# Decimals Formatting + diff --git a/en-product/datastreams/default-value.md b/en-product/datastreams/default-value.md new file mode 100644 index 0000000..ab26e48 --- /dev/null +++ b/en-product/datastreams/default-value.md @@ -0,0 +1,2 @@ +# Default Value + diff --git a/en-product/datastreams/expose-to-automation.md b/en-product/datastreams/expose-to-automation.md new file mode 100644 index 0000000..cc5269a --- /dev/null +++ b/en-product/datastreams/expose-to-automation.md @@ -0,0 +1,2 @@ +# Expose to Automation + diff --git a/en-product/datastreams/sync-with-the-latest-server-value.md b/en-product/datastreams/sync-with-the-latest-server-value.md new file mode 100644 index 0000000..427362a --- /dev/null +++ b/en-product/datastreams/sync-with-the-latest-server-value.md @@ -0,0 +1,2 @@ +# Sync with the latest server value + diff --git a/en-product/datastreams/wait-for-confirmation-from-the-device.md b/en-product/datastreams/wait-for-confirmation-from-the-device.md new file mode 100644 index 0000000..30ce770 --- /dev/null +++ b/en-product/datastreams/wait-for-confirmation-from-the-device.md @@ -0,0 +1,2 @@ +# Wait for confirmation from the device + diff --git a/en-product/events/README.md b/en-product/events/README.md new file mode 100644 index 0000000..2d7cfb9 --- /dev/null +++ b/en-product/events/README.md @@ -0,0 +1,2 @@ +# Events + diff --git a/en-product/events/events-code.md b/en-product/events/events-code.md new file mode 100644 index 0000000..cf48b01 --- /dev/null +++ b/en-product/events/events-code.md @@ -0,0 +1,2 @@ +# Events: Code + diff --git a/en-product/events/events-name.md b/en-product/events/events-name.md new file mode 100644 index 0000000..ee6ee40 --- /dev/null +++ b/en-product/events/events-name.md @@ -0,0 +1,2 @@ +# Events: Name + diff --git a/en-product/events/events-notification-period.md b/en-product/events/events-notification-period.md new file mode 100644 index 0000000..096223e --- /dev/null +++ b/en-product/events/events-notification-period.md @@ -0,0 +1,10 @@ +# Events: Notifications Limit + +This setting limits the number of notifications for a specified time period.‌ + +Example: 1 minute period means end-users will only get one notification per 1 minute, even if hardware or API sends more.‌ + +Notifications Limit can be defined per each Event individually.‌ + +Example: If you set two Events to different Notification Limits, they will be processed independently, and end-users will get both notifications accordingly to the specified limits. + diff --git a/en-product/events/events-notification.md b/en-product/events/events-notification.md new file mode 100644 index 0000000..068110f --- /dev/null +++ b/en-product/events/events-notification.md @@ -0,0 +1,2 @@ +# Events: Notification + diff --git a/en-product/events/events-online-offline.md b/en-product/events/events-online-offline.md new file mode 100644 index 0000000..826c94f --- /dev/null +++ b/en-product/events/events-online-offline.md @@ -0,0 +1,2 @@ +# Events: Online, Offline + diff --git a/en-product/general-settings/README.md b/en-product/general-settings/README.md new file mode 100644 index 0000000..c80698a --- /dev/null +++ b/en-product/general-settings/README.md @@ -0,0 +1,2 @@ +# General Settings + diff --git a/en-product/general-settings/manufacturer.md b/en-product/general-settings/manufacturer.md new file mode 100644 index 0000000..7089579 --- /dev/null +++ b/en-product/general-settings/manufacturer.md @@ -0,0 +1,2 @@ +# Manufacturer + diff --git a/en-product/general-settings/offline-ignore-period.md b/en-product/general-settings/offline-ignore-period.md new file mode 100644 index 0000000..1d707c3 --- /dev/null +++ b/en-product/general-settings/offline-ignore-period.md @@ -0,0 +1,2 @@ +# Offline Ignore Period + diff --git a/en-product/info/README.md b/en-product/info/README.md new file mode 100644 index 0000000..2bb2cc5 --- /dev/null +++ b/en-product/info/README.md @@ -0,0 +1,2 @@ +# Info + diff --git a/en-product/info/info-manufacturer.md b/en-product/info/info-manufacturer.md new file mode 100644 index 0000000..7345e09 --- /dev/null +++ b/en-product/info/info-manufacturer.md @@ -0,0 +1,2 @@ +# Info:Manufacturer + diff --git a/en-product/info/info-template-id.md b/en-product/info/info-template-id.md new file mode 100644 index 0000000..99bef85 --- /dev/null +++ b/en-product/info/info-template-id.md @@ -0,0 +1,12 @@ +# Info: Template ID + +Product's Template ID is used to check if new Device is allowed to work with the Product's settings. + +Follow these steps to allow the Device to use Product's Template you need: + +* select the Product, open Info tab and copy it's Template ID \(several Template IDs can be assigned to one Product\); +* in Arduino IDE sketch find a string that contains "\#define BOARD\_TEMPLATE\_ID", change "TMPL0000" by pasting Template ID from the previosu step; +* flash the Device The Device is ready for provision now. + +**Note: the Device will be refused by the app if it's and Product's Template ID don't match.** + diff --git a/en-product/info/offline-ignore-period.md b/en-product/info/offline-ignore-period.md new file mode 100644 index 0000000..1d707c3 --- /dev/null +++ b/en-product/info/offline-ignore-period.md @@ -0,0 +1,2 @@ +# Offline Ignore Period + diff --git a/en-product/metadata.md b/en-product/metadata.md new file mode 100644 index 0000000..196c3fc --- /dev/null +++ b/en-product/metadata.md @@ -0,0 +1,2 @@ +# Metadata + diff --git a/en-product/mobile-app-ui.md b/en-product/mobile-app-ui.md new file mode 100644 index 0000000..84208f2 --- /dev/null +++ b/en-product/mobile-app-ui.md @@ -0,0 +1,2 @@ +# Mobile app UI + diff --git a/en-product/web-dashboard.md b/en-product/web-dashboard.md new file mode 100644 index 0000000..6502fd1 --- /dev/null +++ b/en-product/web-dashboard.md @@ -0,0 +1,2 @@ +# Web Dashboard + diff --git a/en/api/events-api.md b/en/api/events-api.md deleted file mode 100644 index d3f7c5c..0000000 --- a/en/api/events-api.md +++ /dev/null @@ -1,22 +0,0 @@ -# Events API - -To trigger [Events](../product/product-template-settings/events/) creation from hardware \(or other sources\) and render them on Timeline in Device profile pages on the web and in the mobile apps, use this API call: - -```text -/external/api/logEvent?token={token}&code={event_name} -``` - -`event_name` should be taken from [Product Template Settings](../product/product-template-settings/) > [Events](../product/product-template-settings/events/) - -\*\*\*\* - -**Options:** - -To render custom description of the event on the Timeline, use `event_description` parameter - -`/external/api/logEvent?token={token}&code={event_name}&description={event_desciption}` - - - ->>IMAGE OF TIMELINE WITH EVENT DESCRIPTION \(MOBILE AND WEB\) - diff --git a/en/api/external_api.md b/en/api/external_api.md deleted file mode 100644 index b420c13..0000000 --- a/en/api/external_api.md +++ /dev/null @@ -1,24 +0,0 @@ -# Datastreams API - -## Hardware - -Get datastream value \(via HTTP GET\): - -* `/external/api/get?token={token}&pin={pin}` -* `/external/api/get?token={token}&dataStreamId={id}` - -Update datastream value \(via HTTP GET\): - -* `/external/api/update?token={token}&pin={pin}&value={value}` -* `/external/api/update?token={token}&dataStreamId={id}&value={value}` -* `/external/api/update/property?token={token}&pin={pin}&{property}={value}` - -Get device json \(via HTTP GET\): - -* `/external/api/device?token={token}` - -## Log event - -* `/external/api/logEvent?token={token}&code={event_name}` -* `/external/api/logEvent?token={token}&code={event_name}&description={event_desciption}` - diff --git a/firmware-api-1/disable-widgets-in-the-app.md b/firmware-api-1/disable-widgets-in-the-app.md index 68aff09..3dcb0e9 100644 --- a/firmware-api-1/disable-widgets-in-the-app.md +++ b/firmware-api-1/disable-widgets-in-the-app.md @@ -6,9 +6,7 @@ This command disables and enables widget in the app Blynk.setProperty(V0,"isDisabled", true); ``` - - -TESTING TABS: +TESTING TABS: {% tabs %} {% tab title="C++" %} diff --git a/https-api/events-api.md b/https-api/events-api.md index c42dc82..07a3c8b 100644 --- a/https-api/events-api.md +++ b/https-api/events-api.md @@ -1,22 +1,20 @@ -# Events API +# Events -To trigger [Events](../product-1/events/) creation from hardware \(or other sources\) and render them on Timeline in Device profile pages on the web and in the mobile apps, use this API call: +To trigger [Events](https://github.com/blynkkk/blynkkk.github.io/tree/831614e30e8c03a227832d3bc2d90041f8ca8608/en/product/product-template-settings/events/README.md) creation from hardware \(or other sources\) and render them on Timeline in Device profile pages on the web and in the mobile apps, use this API call: ```text /external/api/logEvent?token={token}&code={event_name} ``` -`event_name` should be taken from [Product Template Settings](../product-1/product-template-settings.md) > [Events](../product-1/events/) +`event_name` should be taken from [Product Template Settings](https://github.com/blynkkk/blynkkk.github.io/tree/831614e30e8c03a227832d3bc2d90041f8ca8608/en/product/product-template-settings/README.md) > [Events](https://github.com/blynkkk/blynkkk.github.io/tree/831614e30e8c03a227832d3bc2d90041f8ca8608/en/product/product-template-settings/events/README.md) \*\*\*\* -**Options:** +**Options:** To render custom description of the event on the Timeline, use `event_description` parameter `/external/api/logEvent?token={token}&code={event_name}&description={event_desciption}` - - >>IMAGE OF TIMELINE WITH EVENT DESCRIPTION \(MOBILE AND WEB\) diff --git a/https-api/external_api.md b/https-api/external_api.md index 6f2ab7a..bf3fcbd 100644 --- a/https-api/external_api.md +++ b/https-api/external_api.md @@ -1,6 +1,8 @@ # Devices -## Devices +## Datastreams API + +### Hardware Get datastream value \(via HTTP GET\): @@ -13,152 +15,122 @@ Update datastream value \(via HTTP GET\): * `/external/api/update?token={token}&dataStreamId={id}&value={value}` * `/external/api/update/property?token={token}&pin={pin}&{property}={value}` -## Log event +Get device json \(via HTTP GET\): + +* `/external/api/device?token={token}` + +### Log event * `/external/api/logEvent?token={token}&code={event_name}` * `/external/api/logEvent?token={token}&code={event_name}&description={event_desciption}` +## Devices +### Devices +#### Get datastream value +Use HTTP **GET** method to get value of a Datastream or Virtual Pin -{% api-method method="get" host="/external/api/" path="update?token={token}&pin={pin}&value={value}" %} -{% api-method-summary %} -Update Datastream value -{% endapi-method-summary %} - -{% api-method-description %} +Using Datastream ID: -{% endapi-method-description %} +```text +/external/api/get?token={token}&dataStreamId={id} +``` -{% api-method-spec %} -{% api-method-request %} -{% api-method-path-parameters %} -{% api-method-parameter name="" type="string" required=false %} +Using Virtual Pin: -{% endapi-method-parameter %} -{% endapi-method-path-parameters %} -{% endapi-method-request %} +```text +/external/api/get?token={token}&pin={pin} +``` -{% api-method-response %} -{% api-method-response-example httpCode=200 %} -{% api-method-response-example-description %} +**Parameters:** -{% endapi-method-response-example-description %} +* `token`: AuthToken of the device +* `pin`: Virtual Pin number. e.g. V0 +* `dataStreamId`: can be found in Product Settings > Datastreams -``` +Example: +```text +curl --get 'https://blynk.io/external/api/get?token=123&pin=V0' ``` -{% endapi-method-response-example %} -{% endapi-method-response %} -{% endapi-method-spec %} -{% endapi-method %} -{% api-method method="get" host="/external/api/" path="get?token={token}&pin={pin}" %} -{% api-method-summary %} -Get Virtual Pin value -{% endapi-method-summary %} +#### Update Datastream value \(using GET\): -{% api-method-description %} +You can use HTTP **GET** method to update value of a Datastream or Virtual Pin -{% endapi-method-description %} +Using Datastream ID: -{% api-method-spec %} -{% api-method-request %} -{% api-method-path-parameters %} -{% api-method-parameter name="token" type="string" required=false %} +```text +/external/api/update?token={token}&dataStreamId={id}&value={value} +``` -{% endapi-method-parameter %} +Using Virtual Pin number: -{% api-method-parameter name="pin" type="string" required=false %} +```text +/external/api/update?token={token}&pin={pin}&value={value} +``` -{% endapi-method-parameter %} -{% endapi-method-path-parameters %} -{% endapi-method-request %} +**Path parameters:** -{% api-method-response %} -{% api-method-response-example httpCode=200 %} -{% api-method-response-example-description %} +* `token`: AuthToken of the device +* `dataStreamId`: can be found in Product Settings > Datastreams +* `pin`: Virtual Pin number. e.g. V0 -{% endapi-method-response-example-description %} +Example: +```text +curl --get 'https://blynk.io/external/api/update?token=123&dataStreamId=1&value=100' ``` -``` -{% endapi-method-response-example %} -{% endapi-method-response %} -{% endapi-method-spec %} -{% endapi-method %} +#### Update Widget parameters -{% api-method method="get" host="/external/api/" path="update?token={token}&pin={pin}&value={value}" %} -{% api-method-summary %} -Update Virtual Pin value -{% endapi-method-summary %} +You can update variuous properties of a widget \(in the mobile app\) which is using a specified Virtual Pin. Full list of properties here\(LINK\) -{% api-method-description %} +```text +/external/api/update/property?token={token}&pin={pin}&{property}={value} +``` -{% endapi-method-description %} +**Path parameters:** -{% api-method-spec %} -{% api-method-request %} -{% api-method-path-parameters %} -{% api-method-parameter name="token" type="string" required=true %} -AuthToken of device -{% endapi-method-parameter %} +* `token`: AuthToken of the device +* `property`: property name. Full list of properties is here \(LINK\) +* `pin`: Virtual Pin number. e.g. V0 -{% api-method-parameter name="pin" type="string" required=true %} -Virtual Pin number. e.g. V1 -{% endapi-method-parameter %} +Example: -{% api-method-parameter name="value" type="string" required=true %} -value to update -{% endapi-method-parameter %} -{% endapi-method-path-parameters %} -{% endapi-method-request %} +```text +curl --get 'https://blynk.io/external/api/update/property?token=123&pin=V0&isDisabled=true' +``` -{% api-method-response %} -{% api-method-response-example httpCode=200 %} -{% api-method-response-example-description %} +### Events -{% endapi-method-response-example-description %} +#### Create Event -``` +Use HTTP **GET** method to create a new Event on Device Timeline +```text +/external/api/logEvent?token={token}&code={event_name}&description={event_desciption} ``` -{% endapi-method-response-example %} -{% endapi-method-response %} -{% endapi-method-spec %} -{% endapi-method %} - -{% api-method method="get" host="/external/api/" path="get?token={token}&pin={pin}" %} -{% api-method-summary %} - -{% endapi-method-summary %} -{% api-method-description %} +**Parameters:** -{% endapi-method-description %} +* `token`: AuthToken of the device +* `code`: code of the event. Can be found in Product Template - [Events](https://github.com/blynkkk/blynkkk.github.io/tree/ba877e83fafb998294c9504da8a7bba02318caf5/en/product-1/events/README.md) +* `description`: optionally you can add custom description to the event and it will be rendered on Device Timeline in mobile apps and on the web -{% api-method-spec %} -{% api-method-request %} -{% api-method-path-parameters %} -{% api-method-parameter name="" type="string" required=false %} +Example: -{% endapi-method-parameter %} -{% endapi-method-path-parameters %} -{% endapi-method-request %} +```text +curl --get 'https://blynk.io/external/api/logEvent?token=123&code=critical_error&description="custom description"' +``` -{% api-method-response %} -{% api-method-response-example httpCode=200 %} -{% api-method-response-example-description %} +Create Event on Device Timeline -{% endapi-method-response-example-description %} +* `/external/api/logEvent?token={token}&code={event_name}` -``` +\`\` -``` -{% endapi-method-response-example %} -{% endapi-method-response %} -{% endapi-method-spec %} -{% endapi-method %} +* `/external/api/logEvent?token={token}&code={event_name}&description={event_desciption}`