Skip to content

Commit ca1de08

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

22 files changed

+97
-154
lines changed

content/applications/general/iot.rst

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ The following IoT systems are supported:
1818

1919
.. note::
2020
- :abbr:`MRP (Material Requirement Planning)` devices, including cameras and measurement tools,
21-
are not compatible with Windows virtual IoT.
21+
are not compatible with the Windows virtual IoT.
2222
- Multiple IoT systems can be used at the same time.
2323
- It is also possible to create a Windows Virtual Machine on a MacOS/Linux computer. However,
2424
this option is not supported by Odoo, and no troubleshooting assistance will be provided.
@@ -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>`_
@@ -55,7 +53,7 @@ to your subscription, contact the database's account manager or Odoo partner for
5553
:target: iot/windows_iot
5654
:large:
5755

58-
Set up Windows virtual IoT.
56+
Set up a Windows virtual IoT.
5957

6058
.. card:: IoT system connection to Odoo
6159
:target: iot/connect
@@ -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: 24 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,24 @@ 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>`.
32+
33+
.. tip::
34+
The :doc:`IoT box <iot_box>`'s name is composed of the IoT box's serial number and
35+
:ref:`pairing code <iot/connect/pairing-code>`.
2836

2937
.. _iot/connect/pairing-code:
3038

3139
Connection using a pairing code
3240
-------------------------------
3341

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

6674
#. 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`.
75+
#. In the :guilabel:`Searching for an IoT Box` popup that opens, click :guilabel:`Use Pairing Code`.
76+
#. Enter the :guilabel:`Pairing code` and click :guilabel:`Connect`.
6977

7078
.. _iot/connect/token:
7179

7280
Connection using a connection token
7381
-----------------------------------
7482

7583
#. 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`.
84+
#. In the :guilabel:`Searching for an IoT Box` popup that opens, click :guilabel:`Offline pairing`.
85+
#. In the :guilabel:`Pair an IoT Box offline` popup that opens, copy the :guilabel:`Token`.
7786
#. Access the :ref:`IoT box's <iot/iot-box/homepage>` or :ref:`Windows virtual IoT's
7887
<iot/windows-iot/homepage>` homepage.
7988
#. In the :guilabel:`Odoo database connected` section, click :guilabel:`Configure`.
@@ -88,14 +97,14 @@ IoT system form
8897
===============
8998

9099
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.
100+
Click the card to access the IoT system's form, which allows to:
94101

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`.
102+
- access the :ref:`IoT box's <iot/windows-iot/homepage>` or :ref:`Windows virtual IoT's
103+
<iot/iot-box/homepage>` homepage.
104+
- view the list of :doc:`devices <devices>` connected to the IoT system;
105+
- access the IoT system's :guilabel:`Technical Information`, such as its :guilabel:`Domain address`,
106+
:guilabel:`Image version`, and :doc:`SSL certificate <iot_advanced/https_certificate_iot>`
107+
:guilabel:`End Date`.
99108

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

148157
:ref:`Update the IoT system's image <iot/updating_iot/image-code>` by flashing the IoT box's card or
149158
: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**.
159+
:ref:`reinstalling the virtual IoT package <iot/windows-iot/installation>`.

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,8 @@ scale's drivers <iot_updating_iot/handlers>`.
1919
the Odoo IoT system <https://www.odoo.com/page/iot-hardware>`_. In such cases, a different scale
2020
must be used.
2121

22-
Once the scale is connected to the IoT system, :ref:`configure it in the POS settings <pos/scale>`.
22+
Once the scale is connected to the IoT system, :ref:`configure it in the POS settings
23+
<pos/hardware/scale>`.
2324

2425
.. seealso::
2526
:doc:`Connect an IoT system to a POS </applications/sales/point_of_sale/configuration/pos_iot>`

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

Lines changed: 23 additions & 92 deletions
Original file line numberDiff line numberDiff line change
@@ -2,109 +2,40 @@
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 box <../iot_box>` can be connected to a screen, e.g. to ease the IoT box's setup
6+
and/or serve as a :ref:`customer display <pos/hardware/display>` to show customers their :doc:`Point
7+
of Sale </applications/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>`).
30-
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.
46-
47-
If the connection was successful, the screen should display the :guilabel:`POS Client display`
48-
screen.
49-
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.
54-
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`.
58-
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.
12+
Connect the screen to the IoT box using a micro-HDMI cable.
6213

6314
.. note::
64-
If no screen is detected, a default display named :guilabel:`Distant Display` will be displayed
65-
instead. This indicates that there is no hardware screen connected.
66-
67-
.. image:: screen/screen-no-screen.png
68-
:align: center
69-
:alt: The "Distant Display" screen name will be used if no screen is detected.
70-
71-
.. _iot/usage_screen:
15+
Avoid using micro-HDMI adapters, as they can cause display issues such as a blank or black
16+
screen.
7217

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.
18+
If the connection was successful, the external monitor displays the :guilabel:`Status display`
19+
screen.
8520

86-
.. image:: screen/screen-pos-screen-config.png
87-
:align: center
88-
:alt: Connect the screen display to the Point of Sale app.
21+
.. image:: screen/screen-status-display.png
22+
:alt: Default Status Display screen
8923

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.
24+
The screen also appears in the IoT box's list of devices:
9225

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.
26+
- on the :ref:`IoT box's form <iot/connect/IoT-form>`;
27+
- on the :ref:`IoT box's homepage <iot/iot-box/homepage>`;
28+
- in the IoT app, under the menu :menuselection:`IoT --> Devices`.
9729

98-
The screen will automatically show the :abbr:`PoS (Point of Sale)` orders and update when changes
99-
are made to the order.
30+
.. tip::
31+
If the screen is not detected, try rebooting the IoT box.
10032

101-
.. image:: screen/screen-pos-client-display.png
102-
:align: center
103-
:alt: An example of a PoS order on a screen display.
33+
Customer display
34+
================
10435

105-
Display a website on the screen
106-
-------------------------------
36+
To use the screen as a :ref:`customer display <pos/hardware/display>`, :ref:`configure the POS
37+
accordingly <pos/hardware/display-configuration>`.
10738

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.
39+
To display a specific website on the screen instead of the POS customer display, go to
40+
:menuselection:`IoT --> Devices`, click the screen's card, then enter the desired website's URL in
41+
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.

0 commit comments

Comments
 (0)