diff --git a/content/applications/general/iot/config.rst b/content/applications/general/iot/config.rst index 8572e44ca..744b3b12e 100644 --- a/content/applications/general/iot/config.rst +++ b/content/applications/general/iot/config.rst @@ -11,5 +11,5 @@ Configuration config/connect config/pos config/https_certificate_iot - config/flash_sdcard + config/updating_iot config/troubleshooting diff --git a/content/applications/general/iot/config/connect.rst b/content/applications/general/iot/config/connect.rst index 218632c59..e85a618d0 100644 --- a/content/applications/general/iot/config/connect.rst +++ b/content/applications/general/iot/config/connect.rst @@ -37,8 +37,8 @@ via :ref:`WiFi `. .. important:: The disk image that the :abbr:`IoT (Internet of Things)` box SD card is formatted with is unique to the version of the Odoo database that the :abbr:`IoT (Internet of Things)` box is running on. - Ensure that the :abbr:`IoT (Internet of Things)` box is :doc:`flashed ` with the - most up-to-date disk image. + Ensure that the :abbr:`IoT (Internet of Things)` box is :ref:`flashed ` with + the most up-to-date disk image. .. _iot_connect/ethernet: diff --git a/content/applications/general/iot/config/flash_sdcard.rst b/content/applications/general/iot/config/flash_sdcard.rst deleted file mode 100644 index 7891f3f2c..000000000 --- a/content/applications/general/iot/config/flash_sdcard.rst +++ /dev/null @@ -1,68 +0,0 @@ -==================== -Flashing the SD card -==================== - -In some circumstances, the :abbr:`IoT (Internet of Things)` box's micro SD Card may need to be -re-flashed to benefit from Odoo's latest :abbr:`IoT (Internet of Things)` image update. This means -that the Odoo :abbr:`IoT (Internet of Things)` box software may need to be updated. - -Upgrade from the IoT box home page -================================== - -Go to the :abbr:`IoT (Internet of Things)` box homepage by navigating to :menuselection:`IoT app --> -IoT Boxes` and clicking on the :guilabel:`IP address` of the :abbr:`IoT (Internet of Things)` box. -Then click on :guilabel:`Update` (next to the version number). - -If a new version of the :abbr:`IoT (Internet of Things)` Box image is available, an -:guilabel:`Upgrade to _xx.xx_` button will appear at the bottom of the page. Click this button to -upgrade the unit and the :abbr:`IoT (Internet of Things)` box will then flash itself to the new -version. All of the previous configurations will be saved. - -.. note:: - This process can take more than 30 minutes. Do not turn off or unplug the :abbr:`IoT (Internet of - Things)` box as it would leave it in an inconsistent state. This means that the :abbr:`IoT - (Internet of Things)` box will need to be re-flashed with a new image. See - :ref:`flash_sdcard/etcher`. - -.. image:: flash_sdcard/flash-upgrade.png - :align: center - :alt: IoT box software upgrade in the IoT Box Home Page. - -.. _flash_sdcard/etcher: - -Upgrade with Etcher Software -============================ - -.. note:: - A computer with a micro SD card reader/adapter is required in order to re-flash the micro SD - card. - -Navigate to Balena's website and download `Etcher `_. It's a free and -open-source utility used for burning image files onto drives. Click to `download -`_. Install and launch the program on the computer. - -Then download the version-specific :abbr:`IoT (Internet of Things)` image from `nightly -`_. - -The following are image versions on the `nightly `_ website -with their corresponding Odoo database version: - -- Odoo V16 --> iotbox-latest.zip -- Odoo V15 --> iotboxv21_10.zip -- Odoo V14 --> iotboxv21_04.zip -- Odoo V13 --> iotboxv20_10.zip - -The images should be downloaded and extracted to a convenient file location. - -After this step is complete, insert the :abbr:`IoT (Internet of Things)` box's micro SD card into -the computer or reader. Open *Etcher* and select :guilabel:`Flash from file`, then find and select -the image just downloaded and extracted. Next, select the drive the image should be burned to. -Lastly, click on :guilabel:`Flash` and wait for the process to finish. - -.. image:: flash_sdcard/etcher-app.png - :align: center - :alt: Balena's Etcher software dashboard. - -.. note:: - An alternative software for flashing the micro SD card is *Raspberry Pi Imager*. Download the - *Raspberry Pi* software `here `_. diff --git a/content/applications/general/iot/config/troubleshooting.rst b/content/applications/general/iot/config/troubleshooting.rst index bedf8fee7..3e87d20f8 100644 --- a/content/applications/general/iot/config/troubleshooting.rst +++ b/content/applications/general/iot/config/troubleshooting.rst @@ -19,10 +19,10 @@ The pairing code does not show under the following circumstances: It is automatically removed from connected displays when this time has expired. - The version of the :abbr:`IoT (Internet of Things)` box image is too old. If the :abbr:`IoT (Internet of Things)` box image is from an earlier version, then the SD card of the :abbr:`IoT - (Internet of Things)` box will need to be re-flashed to update the image (see :doc:`Flashing the - SD Card `). + (Internet of Things)` box needs to be re-flashed to update the image (see :ref:`Flashing the SD + Card `). -If none of the cases listed above correct the issue, then make sure that the :abbr:`IoT (Internet of +If none of the cases listed above correct the issue, then make sure the :abbr:`IoT (Internet of Things)` box has correctly started, by checking that a fixed green LED is showing next to the power port. diff --git a/content/applications/general/iot/config/updating_iot.rst b/content/applications/general/iot/config/updating_iot.rst new file mode 100644 index 000000000..88c11290d --- /dev/null +++ b/content/applications/general/iot/config/updating_iot.rst @@ -0,0 +1,137 @@ +============== +Updating (IoT) +============== + +Due to the complexity of the :abbr:`IoT (Internet of Things)` box, and virtual Windows :abbr:`IoT +(Internet of Things)` box, the term 'updating' can mean several different things. + +The actual drivers can be updated, the core code on the :abbr:`IoT (Internet of Things)` box can be +updated, or a new image can be flashed (using a physical :abbr:`IoT (Internet of Things)` box). + +This document explores the various ways to update :abbr:`IoT (Internet of Things)` boxes to ensure +smooth operation of :abbr:`IoT (Internet of Things)` box processes and devices. + +.. _iot/config/flash: + +Flashing the SD card on IoT box +=============================== + +.. important:: + This update does **not** apply to the Windows :abbr:`IoT (Internet of Things)` box (Odoo 16 and + higher). + + To update the Windows :abbr:`IoT (Internet of Things)`, first, uninstall the previous version of + the Odoo Windows program, and then reinstall it using the most up-to-date installation package. + + To begin the installation, navigate to the Odoo 16 (or higher) installation package for + Enterprise or Community - Windows edition, at `Odoo's download page + `_. + +In some circumstances, the :abbr:`IoT (Internet of Things)` box's micro SD Card may need to be +re-flashed with *Etcher* software to benefit from Odoo's latest :abbr:`IoT (Internet of Things)` +image update. This means the Odoo :abbr:`IoT (Internet of Things)` box software may need to be +updated in instances of a new :abbr:`IoT (Internet of Things)` box, or when a handler's update, or +an update from the :abbr:`IoT (Internet of Things)` box home page, does not resolve issues. + + +.. note:: + - It is often necessary to re-flash the :abbr:`IoT (Internet of Things)` box's image after + upgrading the Odoo database to a new version. + - A computer with a micro SD card reader/adapter is **required** to re-flash the micro SD card. + +First, begin by downloading `Etcher `_. It is a free, +open-source utility, used for burning image files onto drives. After the download completes, install +and launch the program on the computer. + +Then, download the latest :abbr:`IoT (Internet of Things)` image from `nightly +`_, which will be labeled as `iotbox-latest.zip`. This +particular image is compatible with *all* supported versions of Odoo. + +After this step is complete, insert the :abbr:`IoT (Internet of Things)` box's micro SD card into +the computer or reader. Open *Etcher*, and select :guilabel:`Flash from file`, then find and select +the `iotbox-latest.zip` image and extract it. Next, select the drive the image should be burned to. + +Lastly, click :guilabel:`Flash`, and wait for the process to finish. + +.. image:: updating_iot/etcher-app.png + :align: center + :alt: Balena's Etcher software dashboard. + +.. tip:: + Balena's *Etcher* software also allows for the administrator to flash the :abbr:`SD (Secure + Digital)` card from a :abbr:`URL (Uniform Resource Locator)`. To flash from a :abbr:`URL (Uniform + Resource Locator)`, simply click :guilabel:`Flash from URL`, instead of :guilabel:`Flash from + file`. + + Then, enter the following: `http://nightly.odoo.com/master/iotbox/iotbox-latest.zip`. + + .. image:: updating_iot/url-flash.png + :align: center + :alt: A view of Balena's Etcher software, with the flash from URL option highlighted. + +.. note:: + An alternative software for flashing the micro SD card is `Raspberry Pi Imager + `_. + +.. _iot/config/homepage-upgrade: + +Update from the IoT box home page +================================= + +In the background, the :abbr:`IoT (Internet of Things)` box uses a version of Odoo code to run and +connect to the Odoo database. This code may need to be updated in order for the :abbr:`IoT (Internet +of Things)` box to operate effectively. This operation should be completed on a routine basis, to +ensure the :abbr:`IoT (Internet of Things)` system, and its processes, stay up-to-date. + +Go to the :abbr:`IoT (Internet of Things)` box home page by navigating to :menuselection:`IoT app +--> IoT Boxes`, and clicking on the :guilabel:`IP address` of the :abbr:`IoT (Internet of Things)` +box. Then, click on :guilabel:`Update` (next to the version number). + +If a new version of the :abbr:`IoT (Internet of Things)` box image is available, an +:guilabel:`Upgrade to _xx.xx_` button appears at the bottom of the page. Click this button to +upgrade the unit, at which point the :abbr:`IoT (Internet of Things)` box flashes itself to the +newer version. All of the previous configurations are then saved. + +.. important:: + This process can take more than 30 minutes. Do **not** turn off, or unplug, the :abbr:`IoT + (Internet of Things)` box, as it would leave it in an inconsistent state. This means the + :abbr:`IoT (Internet of Things)` box needs to be :ref:`re-flashed ` with a new + image. + +.. image:: updating_iot/flash-upgrade.png + :align: center + :alt: IoT box software upgrade in the IoT Box Home Page. + +Handler (driver) update +======================= + +There may be some instances where drivers or interfaces need to be updated for individual devices +(e.g. scales, measurement tools, etc.). The IoT handler's (drivers and interfaces) code can be +modified by syncing them with the configured server handler's code. + +This can be helpful in instances where :abbr:`IoT (Internet of Things)` devices (e.g. scales, +measurement tools, etc.) are not working properly with the :abbr:`IoT (Internet of Things)` box. + +For both the Windows :abbr:`IoT (Internet of Things)` (Odoo 16 and higher) and physical :abbr:`IoT +(Internet of Things)` box, this process can be performed manually from the :abbr:`IoT (Internet of +Things)` box home page. Go to the :abbr:`IoT (Internet of Things)` box home page by navigating to +:menuselection:`IoT app --> IoT Boxes`, and clicking on the :guilabel:`IP address` of the :abbr:`IoT +(Internet of Things)` box. + +Next, click :guilabel:`Handlers list`, and then select :guilabel:`Load Handlers` at the bottom of +the page. + +.. image:: updating_iot/load-handlers.png + :align: center + :alt: Handlers list on an IoT box with the load handlers button highlighted. + +.. important:: + Handler's code is fetched from the configured server, and it needs to be up-to-date to have the + latest fixes and patches. + +.. note:: + A handler update is also performed automatically each time the :abbr:`IoT (Internet of Things)` + box is restarted. The only exception to this process is if the *Automatic drivers update* is + unchecked in the form view of the :abbr:`IoT (Internet of Things)` box on the Odoo server. This + setting can be reached by going to :menuselection:`IoT App --> Select the IoT box --> Automatic + drivers update`. diff --git a/content/applications/general/iot/config/flash_sdcard/etcher-app.png b/content/applications/general/iot/config/updating_iot/etcher-app.png similarity index 100% rename from content/applications/general/iot/config/flash_sdcard/etcher-app.png rename to content/applications/general/iot/config/updating_iot/etcher-app.png diff --git a/content/applications/general/iot/config/flash_sdcard/flash-upgrade.png b/content/applications/general/iot/config/updating_iot/flash-upgrade.png similarity index 100% rename from content/applications/general/iot/config/flash_sdcard/flash-upgrade.png rename to content/applications/general/iot/config/updating_iot/flash-upgrade.png diff --git a/content/applications/general/iot/config/updating_iot/load-handlers.png b/content/applications/general/iot/config/updating_iot/load-handlers.png new file mode 100644 index 000000000..d40d0a153 Binary files /dev/null and b/content/applications/general/iot/config/updating_iot/load-handlers.png differ diff --git a/content/applications/general/iot/config/updating_iot/url-flash.png b/content/applications/general/iot/config/updating_iot/url-flash.png new file mode 100644 index 000000000..2d1cd0c42 Binary files /dev/null and b/content/applications/general/iot/config/updating_iot/url-flash.png differ diff --git a/redirects/15.0.txt b/redirects/15.0.txt index d91e74ca8..d45a4e337 100644 --- a/redirects/15.0.txt +++ b/redirects/15.0.txt @@ -100,6 +100,7 @@ applications/general/email_communication/email_template.rst applications/general applications/general/export_import_data.rst applications/essentials/export_import_data.rst # general/* -> essentials/* applications/general/geolocation.rst applications/general/integrations/geolocation.rst # * -> integrations/* applications/general/in_app_purchase.rst applications/essentials/in_app_purchase.rst # general/* -> essentials/* +applications/general/iot/config/flash_sdcard.rst applications/general/iot/config/updating_iot.rst # flash_sdcard --> updating_iot applications/general/payment_acquirers/adyen.rst applications/finance/payment_acquirers/adyen.rst applications/general/payment_acquirers/alipay.rst applications/finance/payment_acquirers/alipay.rst applications/general/payment_acquirers/buckaroo.rst applications/finance/payment_acquirers/buckaroo.rst