Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 6 additions & 8 deletions content/applications/general/iot.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,12 +28,10 @@ The following IoT systems are supported:
IoT box subscription
====================

An IoT box subscription is required for production use of IoT systems. If you have issues related
to your subscription, contact the database's account manager or Odoo partner for assistance.

.. tip::
If the subscription is linked to an `Odoo.com <https://www.odoo.com>`_ portal user, check the
information on the portal's subscription page.
An IoT box subscription is required for production use of IoT systems and generating the
:doc:`HTTPS certificate <iot/iot_advanced/https_certificate_iot>`. It is created automatically
when an IoT system is :doc:`connected to the database <iot/connect>`. If you have issues related to
your subscription, contact the database's account manager or Odoo partner for assistance.

.. seealso::
- `Odoo's compatible IoT devices <https://www.odoo.com/app/iot-hardware>`_
Expand Down Expand Up @@ -70,8 +68,8 @@ to your subscription, contact the database's account manager or Odoo partner for
.. card:: HTTPS certificate
:target: iot/iot_advanced/https_certificate_iot

Verify your IoT system and database meet the eligibility requirements for HTTPS certificate
generation and address any related issues.
Verify your database meet the eligibility requirements for HTTPS certificate generation and
address any related issues.

.. card:: IoT system updates
:target: iot/iot_advanced/updating_iot
Expand Down
36 changes: 20 additions & 16 deletions content/applications/general/iot/connect.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ To connect the IoT system to an Odoo database, the following prerequisites must

- The Internet of Things (IoT) app must be :ref:`installed <general/install>`.
- The IoT system must be connected to the network.
- The computer connecting to Odoo must be on the same network as the IoT system.
- The device connecting to Odoo must be on the same network as the IoT system.

.. note::
It is recommended to connect the IoT system to a **production** instance, as other types of
Expand All @@ -23,16 +23,20 @@ To connect the IoT system to an Odoo database, the following prerequisites must
Connection
==========

The IoT system can be connected to the Odoo database using a :ref:`pairing code
<iot/connect/pairing-code>` or a :ref:`connection token <iot/connect/token>`.
To connect the IoT system to the Odoo database, open the IoT app and click :guilabel:`Connect`.
If an IoT system is detected, it is connected automatically. If multiple IoT
systems are found, select the appropriate one in the popup that opens, then click
:guilabel:`Connect`. If no IoT system is detected automatically, try connecting it to the database
using a :ref:`pairing code <iot/connect/pairing-code>` or a :ref:`connection token
<iot/connect/token>`.

.. _iot/connect/pairing-code:

Connection using a pairing code
-------------------------------

.. note::
- The pairing code is displayed for up to 5 minutes after the IoT system starts. If the code is
- The pairing code is displayed for up to 2 hours after the IoT system starts. If the code is
no longer visible, reboot the IoT box or :ref:`restart the Windows virtual IoT service
<iot/windows_iot/restart>` to display the pairing code again. Alternatively, connect the IoT
system to the database using a :ref:`connection token <iot/connect/token>`.
Expand Down Expand Up @@ -64,16 +68,17 @@ Connection using a pairing code
:guilabel:`Pairing Code` section.

#. In Odoo, open the IoT app and click :guilabel:`Connect`.
#. In the :guilabel:`Connect an IoT Box` popup that opens, enter the :guilabel:`Pairing code`.
#. Click :guilabel:`Pair`.
#. In the :guilabel:`Searching for an IoT Box` popup that opens, click :guilabel:`Use Pairing Code`.
#. Enter the :guilabel:`Pairing code` and click :guilabel:`Connect`.

.. _iot/connect/token:

Connection using a connection token
-----------------------------------

#. In Odoo, open the IoT app and click :guilabel:`Connect`.
#. In the :guilabel:`Connect an IoT Box` popup that opens, copy the :guilabel:`Token`.
#. In the :guilabel:`Searching for an IoT Box` popup that opens, click :guilabel:`Offline pairing`.
#. In the :guilabel:`Pair an IoT Box offline` popup that opens, copy the :guilabel:`Token`.
#. Access the :ref:`IoT box's <iot/iot-box/homepage>` or :ref:`Windows virtual IoT's
<iot/windows-iot/homepage>` homepage.
#. In the :guilabel:`Odoo database connected` section, click :guilabel:`Configure`.
Expand All @@ -88,14 +93,14 @@ IoT system form
===============

Once the IoT system is connected to the Odoo database, it is displayed as a card in the IoT app.
Click the IP address on the card to access the :ref:`IoT box's <iot/windows-iot/homepage>` or
:ref:`Windows virtual IoT's <iot/iot-box/homepage>` homepage. Click the card to access the
list of :doc:`devices <devices>` connected to the IoT system.
Click the card to access the IoT system's form, which allows to:

.. tip::
:ref:`Enable the developer mode <developer-mode>` to access the IoT system's
:guilabel:`Technical Information`, such as its :guilabel:`Identifier`, :guilabel:`Domain
address`, and :guilabel:`Image version`.
- access the :ref:`IoT box's <iot/windows-iot/homepage>` or :ref:`Windows virtual IoT's
<iot/iot-box/homepage>` homepage.
- view the list of :doc:`devices <devices>` connected to the IoT system;
- access the IoT system's :guilabel:`Technical Information`, such as its :guilabel:`Domain address`,
:guilabel:`Image version`, and :doc:`SSL certificate <iot_advanced/https_certificate_iot>`
:guilabel:`End Date`.

.. note::
By default, drivers are automatically :ref:`updated <iot_updating_iot/handlers>` every time the
Expand Down Expand Up @@ -147,5 +152,4 @@ The IoT system is disconnected from the database after an Odoo upgrade

:ref:`Update the IoT system's image <iot/updating_iot/image-code>` by flashing the IoT box's card or
:ref:`uninstalling the Windows virtual IoT program <iot/windows_iot/uninstall>` and
:ref:`reinstalling <iot/windows-iot/installation>` the latest package for Windows **matching your
database's version**.
:ref:`reinstalling the virtual IoT package <iot/windows-iot/installation>`.
Original file line number Diff line number Diff line change
Expand Up @@ -27,23 +27,17 @@ HTTPS certificate generation

The HTTPS certificate is generated automatically. When the IoT system is (re-)started (e.g., after
it is connected to the Odoo database), a request is sent to `<https://www.odoo.com>`_, which returns
the HTTPS certificate if the IoT system and database meet the eligibility criteria:
the HTTPS certificate after a few minutes if the database meets the eligibility criteria:

.. _iot/https_certificate_iot/iot-eligibility:

- The database must be a **production** instance. The database instance should not be a copy, a
duplicate, a staging, or a development environment.
- The Odoo subscription must be ongoing (:guilabel:`In Progress` status) and have an :ref:`IoT
box subscription <iot/iot/iot-subscription>` line.
- The Odoo subscription must be ongoing (:guilabel:`In Progress` status).

When the certificate has been received:

- The IoT system's homepage address is updated to a new HTTPS URL ending with `.odoo-iot.com`. Click
the URL to establish a secure HTTPS connection.

.. image:: https_certificate_iot/iot-new-domain.png
:alt: Odoo IoT app IoT box with .odoo-iot.com domain.

- The IoT system's homepage address is updated to a new HTTPS URL ending with `.odoo-iot.com`.
- The :guilabel:`HTTPS certificate` banner displays the certificate's validity period. To view this
information, click the :icon:`fa-cogs` (:guilabel:`cogs`) button on the IoT system's homepage.

Expand All @@ -58,10 +52,8 @@ The HTTPS certificate does not generate

Potential causes include the following:

- No :ref:`IoT box subscription <iot/iot/iot-subscription>` is linked to your account.
- The :ref:`IoT box subscription <iot/iot/iot-subscription>` was added *after* connecting the IoT
system to the database. In this case, refresh the IoT system's homepage or reboot/:ref:`restart
<iot/windows_iot/restart>` the IoT system to regenerate the HTTPS certificate.
- The database doesn't meet the :ref:`eligibility requirements
<iot/https_certificate_iot/iot-eligibility>` for generating an HTTPS certificate.
- The firewall is preventing the HTTPS certificate from generating correctly. In this case,
deactivate the firewall until the certificate is successfully generated.

Expand Down Expand Up @@ -102,7 +94,7 @@ generation or reception of the HTTPS certificate.
`ERR_IOT_HTTPS_CHECK_NO_SERVER`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

The server configuration is missing, i.e., the Odoo instance is not :doc:`connected <../connect>` to
The server configuration is missing, i.e., the database is not :doc:`connected <../connect>` to
the IoT system.

`ERR_IOT_HTTPS_CHECK_CERT_READ_EXCEPTION`
Expand All @@ -114,11 +106,11 @@ Verify that the HTTPS certificate file is readable.
`ERR_IOT_HTTPS_LOAD_NO_CREDENTIAL`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

The contract and/or database :abbr:`UUID (Universal Unique Identifier)` is missing form the IoT.
The contract and/or database :abbr:`UUID (Universal Unique Identifier)` is missing from the IoT.

Verify that both values are correctly configured. To update them, :ref:`access the IoT box's
<iot/iot-box/homepage>` or :ref:`Windows virtual IoT's homepage <iot/windows-iot/homepage>`,
click the :icon:`fa-cogs` (:guilabel:`cogs`) button, then click :guilabel:`Credential`.
click the :icon:`fa-cogs` (:guilabel:`cogs`) button, then click :guilabel:`Credentials`.

`ERR_IOT_HTTPS_LOAD_REQUEST_EXCEPTION`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
7 changes: 3 additions & 4 deletions content/applications/general/iot/iot_advanced/ssh_connect.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,9 @@ IoT box SSH connection
To provide an :abbr:`SSH (secure shell protocol)` connection to an IoT box, you must generate a
password:

#. Access the IoT box's homepage by opening the IoT app and clicking the IP address displayed
on the IoT box's card.
#. Click the :icon:`fa-cogs` (:guilabel:`cogs`) button at the top-right, then :guilabel:`Remote
Debug`.
#. Open the IoT app, click the relevant IoT box's card, and click :guilabel:`Homepage`.
#. On the IoT system's homepage, click the :icon:`fa-cogs` (:guilabel:`cogs`) button at the
top-right, then :guilabel:`Remote Debug`.
#. In the :guilabel:`Remote Debugging` popup that opens, click :guilabel:`Generate` and save the
password securely. Once you close the popup, the password will no longer be available.

Expand Down
10 changes: 8 additions & 2 deletions content/applications/general/iot/iot_advanced/updating_iot.rst
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,8 @@ Image and core code update

#. `Download balenaEtcher. <https://etcher.balena.io/#download-etcher>`_
#. Insert the IoT box's micro SD card into the computer or adapter.
#. Open balenaEtcher, click :guilabel:`Flash from URL`, and enter the following URL:
`http://nightly.odoo.com/master/iotbox/iotbox-latest.zip`.
#. | Open balenaEtcher, click :guilabel:`Flash from URL`, and enter the following URL:
| `http://nightly.odoo.com/master/iotbox/iotbox-latest.zip`.
#. Click :guilabel:`Select target` and select the SD card.
#. Click :guilabel:`Flash` and wait for the process to finish.

Expand Down Expand Up @@ -87,3 +87,9 @@ are not functioning properly with the IoT system, proceed as follows:
A handler update is also performed automatically every time the IoT system is restarted unless
the :guilabel:`Automatic drivers update` option is disabled in the :guilabel:`Technical
information` tab in the :ref:`IoT system's form <iot/connect/IoT-form>` in Odoo.

xxx
Restart Odoo: restart Odoo software on your IoT Box. Usually done when an update is needed or a bug
is encountered. Generate Password: this is for support mainly. It will generate a new password which
will be used on the iot box. This password is needed to connect to it remotely / acquire some
additional right to modify files on the iot box
23 changes: 17 additions & 6 deletions content/applications/general/iot/iot_box.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,7 @@ IoT box

To start using an IoT box:

#. Make sure you have a :ref:`valid IoT box subscription <iot/iot/iot-subscription>` in addition to
your Odoo subscription.
#. Make sure your database meets the :ref:`elegibility criteria <iot/https_certificate_iot/iot-eligibility>`.
#. Connect your :doc:`devices <devices>` to the IoT box.
#. :ref:`Connect the IoT box to the network <iot/iot_box/network>`.
#. :doc:`Connect the IoT box to your Odoo database <connect>`.
Expand Down Expand Up @@ -53,7 +52,7 @@ Make sure no Ethernet cable is connected to the IoT box and follow these steps:
.. note::
Depending on your operating system, the browser might not open and redirect to the IoT box's
homepage. In this case, open your browser manually and navigate to `http://10.11.12.1`
or any url starting with **http** (e.g., `http://odoo.com`).
or any URL starting with **http** (e.g., `http://odoo.com`).

#. On the IoT box's homepage, click :guilabel:`Configure` next to the :guilabel:`Internet Status`
section.
Expand All @@ -65,6 +64,13 @@ Make sure no Ethernet cable is connected to the IoT box and follow these steps:
computer should automatically reconnect to its original network. If it does not, reconnect to it
manually.

.. tip::
If the IoT box is connected to an external monitor, you can also scan the first QR code displayed
on the screen to connect to the network, then scan the second QR code to access the IoT box's
:ref:`homepage <iot/iot-box/homepage>`. On the homepage, click :guilabel:`Configure` in the
:guilabel:`Internet Status` section, select the relevant Wi-Fi network, enter the password, and
click :guilabel:`Connect`.

.. _iot/iot-box/homepage:

IoT box homepage
Expand All @@ -81,17 +87,22 @@ The IoT box's IP address can be retrieved by:

- connecting the IoT box to an external monitor: the IP address is displayed on the screen.

.. image:: iot_box/iot-pos-display.png
.. image:: iot_box/iot-status-display.png
:scale: 75%
:alt: POS display with IoT box's IP address
:alt: Status display with IoT box's IP address

.. tip::
You can also scan the QR code displayed on the external monitor using a device connected to the
same network as the IoT box to access the IoT box's homepage.

- connecting the IoT box to a `supported receipt or label printer <https://www.odoo.com/app/iot-hardware>`_
with a USB cable: the IP address is automatically printed.
- accessing the administrator interface of the router to which the IoT box is connected or using
third-party software to scan the network.

Once the IoT box is :doc:`connected to the Odoo database <connect>`, its homepage can be accessed
from Odoo by opening the IoT app and clicking the URL displayed on the IoT box's card.
from Odoo by opening the IoT app, clicking the relevant IoT box's card, and clicking
:guilabel:`Homepage`.

.. _iot/iot-box/led-status:

Expand Down
Binary file modified content/applications/general/iot/iot_box/iot-homepage.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions content/applications/general/iot/windows_iot.rst
Original file line number Diff line number Diff line change
Expand Up @@ -122,8 +122,8 @@ the IoT system** and navigate to the URL `http://xxx:8069` (where `xxx` is the I
address).

Once the Windows virtual IoT is :doc:`connected to the Odoo database <connect>`, its homepage can
be accessed from Odoo by opening the IoT app and clicking the URL displayed on the IoT system's
card.
be accessed from Odoo by opening the IoT app, clicking the relevant IoT box's card, and
clicking :guilabel:`Homepage`.

.. image:: windows_iot/iot-windows-homepage.png
:scale: 75%
Expand Down