Skip to content

Commit 5ff440e

Browse files
committed
[IMP] iot: 19.0 updates
task-5108135
1 parent c0e1d73 commit 5ff440e

21 files changed

+90
-143
lines changed

content/applications/general/iot.rst

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -28,12 +28,10 @@ The following IoT systems are supported:
2828
IoT box subscription
2929
====================
3030

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

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

73-
Verify your IoT system and database meet the eligibility requirements for HTTPS certificate
74-
generation and address any related issues.
71+
Verify your database meet the eligibility requirements for HTTPS certificate generation and
72+
address any related issues.
7573

7674
.. card:: IoT system updates
7775
:target: iot/iot_advanced/updating_iot

content/applications/general/iot/connect.rst

Lines changed: 20 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ To connect the IoT system to an Odoo database, the following prerequisites must
99

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

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

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

2933
.. _iot/connect/pairing-code:
3034

3135
Connection using a pairing code
3236
-------------------------------
3337

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

6670
#. In Odoo, open the IoT app and click :guilabel:`Connect`.
67-
#. In the :guilabel:`Connect an IoT Box` popup that opens, enter the :guilabel:`Pairing code`.
68-
#. Click :guilabel:`Pair`.
71+
#. In the :guilabel:`Searching for an IoT Box` popup that opens, click :guilabel:`Use Pairing Code`.
72+
#. Enter the :guilabel:`Pairing code` and click :guilabel:`Connect`.
6973

7074
.. _iot/connect/token:
7175

7276
Connection using a connection token
7377
-----------------------------------
7478

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

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

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

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

148153
:ref:`Update the IoT system's image <iot/updating_iot/image-code>` by flashing the IoT box's card or
149154
:ref:`uninstalling the Windows virtual IoT program <iot/windows_iot/uninstall>` and
150-
:ref:`reinstalling <iot/windows-iot/installation>` the latest package for Windows **matching your
151-
database's version**.
155+
:ref:`reinstalling the virtual IoT package <iot/windows-iot/installation>`.

content/applications/general/iot/devices/screen.rst

Lines changed: 26 additions & 86 deletions
Original file line numberDiff line numberDiff line change
@@ -2,109 +2,49 @@
22
Connect a screen
33
================
44

5-
In Odoo, an :abbr:`IoT (Internet of Things)` box can be connected to a screen display. After being
6-
configured, the screen can be used to display a Point of Sale (PoS) order to a client.
7-
8-
.. figure:: screen/screen-pos-client-display.png
9-
10-
An example of a PoS (point of sale) order on a screen display.
11-
12-
Access the customer display by going to the :abbr:`IoT (Internet of Things)` box homepage and
13-
clicking on the :guilabel:`PoS Display` button. To get to the :abbr:`IoT (Internet of Things)` box
14-
homepage, navigate to :menuselection:`IoT app --> IoT Boxes` and click on the :abbr:`IoT (Internet
15-
of Things)` box homepage link.
5+
The :doc:`IoT system <>` can be connected to a screen, e.g. to ease its setup and/or serve
6+
as a :ref:`customer display <pos/display>` to show customers their :doc:`Point of Sale
7+
<sales/point_of_sale>` orders.
168

179
Connection
1810
==========
1911

20-
The way to connect the screen display to the :abbr:`IoT (Internet of Things)` box differs depending
21-
on the model.
22-
23-
.. tabs::
24-
25-
.. tab:: IoT Box model 4
26-
27-
Connect up to two screens with micro-HDMI cables on the side of the :abbr:`IoT (Internet of
28-
Things)` box. If two screens are connected, they can display distinct content (see
29-
:ref:`Screen Usage <iot/usage_screen>`).
12+
To connect a screen to an IoT system, connect the screen to the IoT system using an HDMI or
13+
micro-HDMI cable (depending on your IoT system) **before** turning the IoT system on. If the IoT
14+
system is already running, connect the screen to it, then reboot the IoT box or :ref:`restart the
15+
Windows virtual IoT service <iot/windows_iot/restart>`
3016

31-
.. tab:: IoT Box model 3
32-
33-
Connect the screen with an HDMI cable on the side of the :abbr:`IoT (Internet of Things)` box.
34-
35-
.. seealso::
36-
:ref:`See the Raspberry Pi Schema <pos/pos_iot/connect_schema>`.
37-
38-
.. important::
39-
Screen(s) should be connected before the :abbr:`IoT (Internet of Things)` box is switched on. If
40-
it is already on, connect the screen(s), and then restart the :abbr:`IoT (Internet of Things)`
41-
box by unplugging it for ten seconds and plugging it back into its power source.
42-
43-
.. warning::
44-
The usage of HDMI/micro-HDMI adapters may cause issues which will result in a blank, black screen
45-
on the screen display. Using the specific cable for the display connection is recommended.
17+
.. note::
18+
Using HDMI or micro-HDMI adapters may cause issues that result in a blank or black screen. It is
19+
recommended to use the specific cable required for the display connection.
4620

47-
If the connection was successful, the screen should display the :guilabel:`POS Client display`
21+
If the connection was successful, the external monitor displays the :guilabel:`Status display`
4822
screen.
4923

50-
.. image:: screen/screen-pos-client-display-no-order.png
51-
:align: center
52-
:alt: The default "POS Client Display" screen that appears when a screen display is successfully
53-
connected to an IoT box.
24+
.. image:: screen/screen-status-diplay.png
25+
:alt: Default Status Display screen
5426

55-
The screen should also appear in the list of :guilabel:`Displays` on the :abbr:`IoT (Internet of
56-
Things)` box homepage. Alternatively, the display can be seen by accessing :menuselection:`IoT app
57-
--> Devices`.
27+
The screen also appears in the IoT system's list of devices:
5828

59-
.. image:: screen/screen-screen-name-example.png
60-
:align: center
61-
:alt: An example of a screen display name shown on the IoT Box Home Page.
29+
- on the :ref:`IoT system's form <iot/connect/IoT-form>`;
30+
- on the :ref:`IoT box's <iot/iot-box/homepage>` or
31+
:ref:`Windows virtual IoT's <iot/windows-iot/homepage>` homepage;
32+
- under the menu :menuselection:`IoT --> Devices`.
6233

6334
.. note::
64-
If no screen is detected, a default display named :guilabel:`Distant Display` will be displayed
35+
If no screen is detected, a default display named :guilabel:`Distant Display` is displayed
6536
instead. This indicates that there is no hardware screen connected.
6637

6738
.. image:: screen/screen-no-screen.png
6839
:align: center
6940
:alt: The "Distant Display" screen name will be used if no screen is detected.
7041

71-
.. _iot/usage_screen:
72-
73-
Usage
74-
=====
75-
76-
Show Point of Sale orders to customers
77-
--------------------------------------
78-
79-
To use the screen in the *Point of Sale app*, go to :menuselection:`Point of Sale -->
80-
Configuration --> Point of Sale`, select a :abbr:`PoS (Point of Sale)`, click :guilabel:`Edit` if
81-
necessary, and enable the :guilabel:`IoT Box` feature.
82-
83-
Next, select the screen from the :guilabel:`Customer Display` drop-down menu. Then click
84-
:guilabel:`Save`, if required.
85-
86-
.. image:: screen/screen-pos-screen-config.png
87-
:align: center
88-
:alt: Connect the screen display to the Point of Sale app.
89-
90-
The screen is now available for :abbr:`PoS (Point of Sale)` sessions. A screen icon will appear in
91-
the menu at the top of the screen to indicate the screen's connection status.
92-
93-
.. image:: screen/screen-pos-icon.png
94-
:align: center
95-
:alt: The "screen" icon on the Point of Sale display shows the connection status with the
96-
screen.
97-
98-
The screen will automatically show the :abbr:`PoS (Point of Sale)` orders and update when changes
99-
are made to the order.
100-
101-
.. image:: screen/screen-pos-client-display.png
102-
:align: center
103-
:alt: An example of a PoS order on a screen display.
42+
Customer display
43+
================
10444

105-
Display a website on the screen
106-
-------------------------------
45+
To use the screen as a :ref:`customer display <pos/hardware/display>`, :ref:`configure the POS must
46+
<pos/hardware/display-configuration>` to use a customer display.
10747

108-
Open the screen form view by accessing :menuselection:`IoT app --> Devices --> Customer Display`.
109-
This allows the user to choose a particular website URL to display on the screen using the
110-
:guilabel:`Display URL` field.
48+
To display a specific website on the screen instead of the POS customer display, go to
49+
:menuselection:`IoT --> Devices`, click the screen's card, then enter the desired website's URL in
50+
the :guilabel:`Display URL` field.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
91 KB
Loading

0 commit comments

Comments
 (0)