[IMP] IoT: edits to all IoT docs

closes odoo/documentation#4927

X-original-commit: e7457c992b
Signed-off-by: Zachary Straub (zst) <zst@odoo.com>
This commit is contained in:
Timothy Kukulka (tiku)
2023-02-24 19:22:49 +00:00
committed by tiku-odoo
parent 0df9068892
commit 1ed317ebd7
73 changed files with 707 additions and 460 deletions
@@ -1,45 +1,82 @@
================
Connect a Camera
Connect a camera
================
When using your *IoT Box* in Odoo, you could need to use a camera. As
it can be done in a few steps, this device is really easy to configure.
Then, you can use it in your manufacturing process and link it to a
control point. Doing so will allow you to take pictures when you reach
the chosen quality control point.
A camera can be connected to an :abbr:`IoT (Internet of Things)` box with an Odoo database in just a
few steps. Once a camera is connected to an :abbr:`IoT (Internet of Things)` box, it can be used in
a manufacturing process, or it can be linked to a quality control point/quality check. Doing so
allows for the taking of pictures when a chosen quality control point/check has been reached, or
when a specific key is pressed during manufacturing.
Connection
==========
To connect the camera to the *IoT Box*, simply connect the two by
cable.
To connect a camera to an :abbr:`IoT (Internet of Things)` box, simply connect the two via cable.
This is usually done with a :abbr:`USB (Universal Serial Bus)` cable of some sort.
If your camera is a `*supported
one* <https://www.odoo.com/page/iot-hardware>`__, there is no need to
set up anything as it will be detected as soon as it is connected.
If the camera is `supported <https://www.odoo.com/page/iot-hardware>`_, there is no need to set up
anything, as it'll be detected as soon as it's connected.
.. image:: camera/camera_01.png
.. image:: camera/camera-dropdown.png
:align: center
:alt: Camera recognized on the IoT box.
Link a Camera to a Quality Control Point
========================================
Link camera to quality control point in manufacturing process
=============================================================
With the Manufacturing app
--------------------------
In the :menuselection:`Quality app`, a device can be set up on a :guilabel:`Quality Control Point`.
To do that, navigate to the :menuselection:`Quality app --> Quality Control --> Control Points` and
open the desired :guilabel:`Control Point` that'll be linked to the camera.
In your *Quality app*, you can setup the device on a *Quality Control
Point*. Go to the *Control Points* menu, under *Quality Control*
and open the control point you want to link with the camera.
On the control point form, edit the control point by selecting the :guilabel:`Type` field, and
clicking on :guilabel:`Take a Picture` from the drop-down menu. Doing so reveals a field called
:guilabel:`Device`, wherein the attached *device* can be selected. :guilabel:`Save` the changes, if
required.
Now, you can edit the control point and select the device from the
dropdown list. Now, hit save.
.. image:: camera/camera_03.png
.. image:: camera/control-point-device.png
:align: center
:alt: Setting up the device on the quality control point.
Then, your camera can be used with the picked *Control Point*. During
the manufacturing process, reaching the *Quality Control Point* you
chose before will allow you to take a picture.
The camera is now useable with the selected quality control point. When the quality control point
is reached during the manufacturing process, the database prompts the operator to take a picture.
.. image:: camera/camera_04.png
.. image:: camera/serial-number-picture.png
:align: center
:alt: Graphic user interface of the device on the quality control point.
.. note::
Quality control points can also be accessed by navigating to :menuselection:`IoT App -->
Devices`. From here, select the device. There is a :guilabel:`Quality Control Points` tab, where
they can be added with the device.
.. tip::
On a quality check form, the :guilabel:`Type` of check can also be specified to :guilabel:`Take a
Picture`. Navigate to :menuselection:`Quality app --> Quality Control --> Quality Checks --> New`
to create a new quality check from the :guilabel:`Quality Checks` page.
.. seealso::
- :doc:`../../../inventory_and_mrp/manufacturing/quality_control/quality_control_points`
- :doc:`../../../inventory_and_mrp/manufacturing/quality_control/quality_alerts`
Link camera to a work center in the Manufacturing app
=====================================================
To link a camera to an action, it first needs to be configured on a work center. Navigate to
:menuselection:`Manufacturing app --> Configuration --> Work Centers`. Next, go to the desired
:guilabel:`Work Center` in which a camera will be used to reveal that specific work center's detail
form. From here, add the device in the :guilabel:`IoT Triggers` tab, in the :guilabel:`Device`
column, by clicking :guilabel:`Add a Line`.
Now, the camera device can be linked to the :guilabel:`Action` column drop-down option labeled
:guilabel:`Take a Picture`. A key can also be added to trigger the action.
.. important::
The first trigger listed is chosen first. The order of triggers matters, and they can be dragged
into any desired order.
.. note::
On the :guilabel:`Work Order` screen, a status graphic indicates whether the database is
correctly connected to the camera.
.. seealso::
:ref:`workcenter_iot`

Before

Width:  |  Height:  |  Size: 5.9 KiB

After

Width:  |  Height:  |  Size: 5.9 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 7.1 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 42 KiB

Before

Width:  |  Height:  |  Size: 9.6 KiB

After

Width:  |  Height:  |  Size: 9.6 KiB

@@ -1,42 +1,52 @@
====================
Connect a Footswitch
Connect a footswitch
====================
When working, it is always better to have your two hands available.
Using Odoos *IoT Box* and a footswitch will allow it.
When working in a manufacturing environment, it's always better for an operator to have both hands
available at all times. Odoo's :abbr:`IoT (Internet of Things)` box makes this possible when using a
footswitch.
In fact, you will be able to go from one screen to another and perform
actions by using your foot and the footswitch. Really convenient, it
can be configured in a few steps.
In fact, with a footswitch, the operator is able to go from one screen to another, and perform
actions using their foot. This can be configured in just a few steps on the work center in the
*Manufacturing* app.
Connection
==========
Connecting the footswitch to the *IoT Box* is easy, you just have to
connect the two by cable.
To connect a footswitch to the :abbr:`IoT (Internet of Things)` box, connect the two devices via
cable. More often than not, this is done with a :abbr:`USB (Universal Serial Bus)` cable.
If your footswitch is a `supported
one <https://www.odoo.com/page/iot-hardware>`__, there is no need to
set up anything since it will be automatically detected when connected.
If the footswitch is a `supported device <https://www.odoo.com/page/iot-hardware>`_, there is no
need to take further action, since it'll be automatically detected when connected.
.. image:: footswitch/footswitch_01.png
.. image:: footswitch/footswitch-dropdown.png
:align: center
:alt: Footswitch recognized on the IoT box.
Link a Footswitch to a Workcenter
=================================
Link a footswitch to a work center in the Odoo Manufacturing app
================================================================
To link the footswitch to an action, it needs to be configured on a
workcenter. Go to the workcenter you want to use the footswitch in and
add the device in the *IoT Triggers* tab. Then, you can link it to an
action and also add a key to trigger it.
To link a footswitch to an action, it first needs to be configured on a work center. Navigate to
:menuselection:`Manufacturing app --> Configuration --> Work Centers`. From here, go to the desired
:guilabel:`Work Center` in which the footswitch will be used, and add the device in the
:guilabel:`IoT Triggers` tab, under the :guilabel:`Device` column, by selecting :guilabel:`Add a
Line`. Doing so means the footswitch can be linked to an option in the :guilabel:`Action` column
drop-down, and optionally, a key can be added to trigger it. An example of an :guilabel:`Action` in
the *Manufacturing app* could be the :guilabel:`Validate` or :guilabel:`Mark as Done` buttons on a
manufacturing work order.
.. image:: footswitch/footswitch_03.png
.. image:: footswitch/footswitch-example.png
:align: center
:alt: Footswitch trigger setup on the Odoo database.
Note that the one that is first in the list will be chosen. So, the
order matters! In the picture above, using the footswitch will, for
example, automatically skip the current part of the process you work on.
.. important::
It should be noted that the first listed trigger is chosen first. So, the order matters, and
these triggers can be dragged into any order. In the picture above, using the footswitch
automatically skips the part of the process that's currently being worked on.
.. note::
When you are on the work order screen, a status button indicates if you
are correctly connected to the footswitch.
On the :guilabel:`Work Order` screen, a status graphic indicates whether the database is
correctly connected to the footswitch.
.. seealso::
:ref:`workcenter_iot`
Binary file not shown.

After

Width:  |  Height:  |  Size: 10 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 7.3 KiB

@@ -1,52 +1,90 @@
==========================
Connect a Measurement Tool
Connect a measurement tool
==========================
With Odoos *IoT Box*, it is possible to connect measurement tools to
your database. Find the list of supported devices here: `Supported
devices <https://www.odoo.com/page/iot-hardware>`__,.
With Odoo's :abbr:`IoT (Internet of Things)` box, it is possible to connect measurement tools to the
Odoo database for use in the *Quality app* on a quality control point/quality check, or for use in a
work center during the manufacturing process.
Connect in USB
==============
Find the list of supported devices here: `Supported devices
<https://www.odoo.com/page/iot-hardware>`_.
To add a device connected by USB, just plug the USB cable in the *IoT
Box*, and the device should appear in your Odoo database.
Connect with universal serial bus (USB)
=======================================
.. image:: measurement_tool/measurement_tool_01.png
To add a device connected by :abbr:`USB (Universal Serial Bus)`, plug the :abbr:`USB (Universal
Serial Bus)` cable into the :abbr:`IoT (Internet of Things)` box, and the device appears in the Odoo
database.
.. image:: measurement_tool/device-dropdown.png
:align: center
:alt: Measurement tool recognized on the IoT box.
Connect in Bluetooth
====================
Connect with bluetooth
======================
Activate the Bluetooth on your device (see your device manual for
further explanation) and the IoT Box will automatically try to connect
to the device.
Activate the Bluetooth functionality on the device (see the device manual for further explanation),
and the :abbr:`IoT (Internet of Things)` box automatically connects to the device.
Here is an example of what it should look like:
.. image:: measurement_tool/measurement_tool_03.png
.. image:: measurement_tool/measurement-tool.jpeg
:align: center
:alt: Bluetooth indicator on measurement tool.
Link a measurement tool to a quality control point
==================================================
With the Manufacturing app
--------------------------
Link a measurement tool to a quality control point in the manufacturing process
===============================================================================
In your *Quality app*, you can setup a device on your *Quality
Control Points*. To do so, go to the *Control Points* menu, under
*Quality Control* and open the control point to which you want to
assign a measurement tool.
In the *Quality app*, a device can be set up on a quality control point. To do that, navigate to
:menuselection:`Quality app --> Quality Control --> Control Points`, and open the desired control
point to which the measurement tool should be linked.
Now, you can edit the control point and choose the device from the
dropdown list. Then, hit save.
From here, edit the control point, by selecting the :guilabel:`Type` field, and clicking
:guilabel:`Measure` from the drop-down menu. Doing so reveals a field called :guilabel:`Device`,
where the attached device can be selected.
.. image:: measurement_tool/measurement_tool_04.png
Additionally, :guilabel:`Norm` and :guilabel:`Tolerance` can be configured. :guilabel:`Save` the
changes, if required.
At this point, the measurement tool is linked to the chosen quality control point. The value, which
usually needs to be changed manually, is automatically updated while the tool is being used.
.. image:: measurement_tool/measurement-control-point.png
:align: center
:alt: Measurement tool input in the Odoo database.
Now, your measurement tool is linked to the chosen *Control Point*.
The value, which needs to be changed manually, will be automatically
updated while the tool is being used.
.. tip::
Quality control points can also be accessed by navigating to :menuselection:`IoT App -->
Devices`, then select the device. There is a :guilabel:`Quality Control Points` tab, where they
can be added with the device.
.. image:: measurement_tool/measurement_tool_05.png
:align: center
.. note::
On a quality check detail form, the :guilabel:`Type` of check can also be specified to
:guilabel:`Measure`. Access a new quality check detail page, by navigating to
:menuselection:`Quality app --> Quality Control --> Quality Checks --> New`.
.. seealso::
- :doc:`../../../inventory_and_mrp/manufacturing/quality_control/quality_control_points`
- :doc:`../../../inventory_and_mrp/manufacturing/quality_control/quality_alerts`
Link a measurement tool to a work center in the Manufacturing app
=================================================================
To link a measurement tool to an action, it first needs to be configured on a work center. To do
that, navigate to :menuselection:`Manufacturing app --> Configuration --> Work Centers`. Then,
select the desired work center in which the measurement tool will be used.
On the work center page, add the device in the :guilabel:`IoT Triggers` tab, under the
:guilabel:`Device` column, by selecting :guilabel:`Add a Line`. Then, the measurement tool can be
linked to the :guilabel:`Action` drop-down menu option labeled :guilabel:`Take Measure`. A key can
be added to trigger the action.
.. important::
It should be noted that the first listed trigger is chosen first. The order matters, and these
triggers can be dragged into any order.
.. note::
On the :guilabel:`Work Order` screen, a status graphic indicates whether the database is
correctly connected to the measurement tool.
.. seealso::
:ref:`workcenter_iot`
Binary file not shown.

After

Width:  |  Height:  |  Size: 8.0 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 4.6 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 67 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 5.8 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 103 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 4.4 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 6.4 KiB

@@ -1,126 +1,121 @@
=================
Connect a Printer
Connect a printer
=================
When using your *IoT Box* in Odoo, you could need to use a printer.
Doing so is easy and convenient as it can be done in a few steps. Then,
you can use it to print receipts, orders or even reports in different
Odoo apps.
Printer installation can be done in a few easy steps. The printer can be used to print receipts,
labels, orders, or even reports from the different Odoo apps. In addition, printer actions can be
assigned as an *action on a trigger* during the manufacturing process, or added onto a quality
control point or a quality check.
Connection
==========
The IoT Box supports printers connected through USB, network or Bluetooth.
`Supported printers <https://www.odoo.com/page/iot-hardware>`__ will be
detected automatically and will appear in the *Devices* list of your IoT app.
The :abbr:`IoT (Internet of Things)` box supports printers connected through :abbr:`USB (Universal
Serial Bus)`, network connection, or Bluetooth. `Supported printers
<https://www.odoo.com/page/iot-hardware>`__ are detected automatically, and appear in the
:guilabel:`Devices` list of the *IoT app*.
.. image:: printer/printer-detected.png
:align: center
:alt: The printer as it would appear in the IoT app devices list.
.. note::
The printer can take up to two minutes to appear in your devices list.
The printer can take up to two minutes to appear in the *IoT app* devices list.
.. image:: printer/printer_01.png
:align: center
Link printer
============
Link the Printer
================
To Work Orders
--------------
You can link *Work Orders* to printers via a *Quality Control Point*
to print labels for manufactured products.
To do so, you need to create a *Quality Control Point* from the
*Quality* app. Then, you can select the correct manufacturing
operation and the work order operation. In type, choose *Print Label*
and hit save.
.. image:: printer/printer_03.png
:align: center
Now, each time you reach the quality control point for the chosen
product, a *Print Label* button will appear.
.. image:: printer/printer_04.png
:align: center
To Reports
----------
You can also link a type of report to a certain printer. In the *IoT*
app, go to the *Devices* menu and select the printer you want to set
up.
.. image:: printer/printer_05.png
:align: center
Now, go to the *Printer Reports* tab.
.. image:: printer/printer_06.png
:align: center
Hit edit and then, click on *Add a line*. In the window that shows up,
check all the types of reports that should be linked to this printer.
Click on select and save.
.. image:: printer/printer_07.png
:align: center
Now, each time you click on *Print* in the control panel, instead of
downloading a PDF, it will send it to the selected printer and
automatically print it.
Print Receipts from the PoS
Link printer to work orders
---------------------------
You can link a printer to your *Point of Sale* app so you can print
receipts directly from your *PoS*.
*Work Orders* can be linked to printers, via a quality control point, to print labels for
manufactured products.
Doing so is really easy. Go to your *Point of Sale* app and open your
*Point of Sale* settings, under *Configuration*. There, click on *Edit*
and check the *IoT Box* feature. Then, choose your *Receipt Printer*
from the dropdown.
In the *Quality app*, a device can be set up on a quality control point. To do that, go to the
:menuselection:`Quality app --> Quality Control --> Control Points`, and open the desired control
point to which the printer will be linked.
.. image:: printer/printer_08.png
.. important::
A *Manufacturing Operation* and *Work Order Operation* need to be attached to a quality control
point before the :guilabel:`Type` field allows for the :guilabel:`Print Label` option to be
selected.
From here, edit the control point, by selecting the :guilabel:`Type` field, and selecting
:guilabel:`Print Label` from the drop-down menu of options. Doing so reveals a field called
:guilabel:`Device`, where the attached *device* can be selected. :guilabel:`Save` the changes, if
required.
.. image:: printer/printer-controlpoint.png
:align: center
:alt: This is the quality control point setup.
The printer can now be used with the selected quality control point. When the quality control point
is reached during the manufacturing process, the database presents the option to print labels for a
specific product.
.. image:: printer/printer-prompt.png
:align: center
Now, you will be able to print different kinds of tickets from your *POS*:
**receipts**, **sale details** and **bills**.
.. tip::
Quality control points can also be accessed by navigating to :menuselection:`IoT App -->
Devices`, then select the device. There is a :guilabel:`Quality Control Points` tab, where they
can be added with the device.
Receipts are printed once the order is validated. The process is
automated when you enable the feature in your *PoS* configuration.
.. note::
On a quality check detail form, the :guilabel:`Type` of check can also be specified to
:guilabel:`Print Label`. To create new quality checks, navigate to :menuselection:`Quality app
--> Quality Control --> Quality Checks --> New`.
Sales details can be printed by clicking on the printer icon on the
navbar at the top of the *PoS*. It will print the details of the sales
of the current day.
.. seealso::
- :doc:`../../../inventory_and_mrp/manufacturing/quality_control/quality_control_points`
- :doc:`../../../inventory_and_mrp/manufacturing/quality_control/quality_alerts`
.. image:: printer/printer_09.png
Link a printer to a work center in the Manufacturing app
--------------------------------------------------------
To link a printer to an action, it first needs to be configured on a work center. To do that,
navigate to :menuselection:`Manufacturing app --> Configuration --> Work Centers`. From here, select
the desired work center in which the printer will be used. Next, add the device in the
:guilabel:`IoT Triggers` tab, under the :guilabel:`Device` column, by selecting :guilabel:`Add a
Line`.
Then, the printer can be linked to either of the following options in the :guilabel:`Actions`
drop-down menu: :guilabel:`Print Labels`, :guilabel:`Print Operation`, or :guilabel:`Print Delivery
Slip`. A key can also be added to trigger the action.
.. important::
The first listed trigger on the form will be chosen first. So, the order matters, and these
triggers can be dragged into any order.
.. note::
On the :guilabel:`Work Order` screen, a status graphic indicates whether the database is
correctly connected to the printer.
.. seealso::
:ref:`workcenter_iot`
Link printer to reports
-----------------------
It's also possible to link a type of report to a certain printer. In the *IoT app*, go to the
:guilabel:`Devices` menu, and select the desired printer that needs to be configured.
From here, click :guilabel:`Edit`, go to the :guilabel:`Printer Reports` tab, and select
:guilabel:`Add a line`. In the window that appears, check all the types of :guilabel:`Reports` that
should be linked to this printer.
.. image:: printer/printers-listed.png
:align: center
:alt: The printer devices listed in the IoT Devices menu.
As for the bill, it is only available in restaurant mode. In your
restaurant settings, activate *Print Bills* and a *Bill* button will
appear in the left panel of the *PoS*.
Now, each time :guilabel:`Print` is selected in the control panel, instead of downloading a PDF,
Odoo sends the report to the selected printer, and automatically prints it.
.. image:: printer/printer_10.png
:align: center
.. seealso::
:doc:`POS Order Printing <../../../sales/point_of_sale/restaurant/kitchen_printing>`
Print Orders in the kitchen
---------------------------
In restaurant mode, you can send order tickets to the kitchen.
To do so, go to the *PoS* app and open your *PoS* settings. Then,
tick *Order Printer*.
.. image:: printer/printer_11.png
:align: center
Now, go to the *Printers* menu. Hit create, select the printer from
the dropdown and, in the *Printer Product Categories* field, choose
all the categories of products that should be printed on this printer.
.. image:: printer/printer_12.png
:align: center
In the *PoS*, when you add or remove a product from one of the
selected categories, the button *Order* will be green. If you click on
it, the IoT Box will print a receipt on the corresponding printer.
.. tip::
Reports can also be configured in the :guilabel:`Technical Menu` while in :ref:`debug mode
<developer-mode>`. To do that, navigate to :menuselection:`Settings App --> Technical Menu -->
Actions --> Reports`. From here, the individual report can be found in this list, where the
:guilabel:`IoT Device` can be set on the report.

Before

Width:  |  Height:  |  Size: 10 KiB

After

Width:  |  Height:  |  Size: 10 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 11 KiB

Before

Width:  |  Height:  |  Size: 5.4 KiB

After

Width:  |  Height:  |  Size: 5.4 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 10 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 14 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 30 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 12 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 4.7 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 16 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 597 B

Binary file not shown.

Before

Width:  |  Height:  |  Size: 1.2 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 6.0 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 21 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 16 KiB

@@ -1,54 +1,57 @@
===============
Connect a Scale
Connect a scale
===============
When using your **IoT Box** in Odoo, you could need to use a scale. Doing so is easy and convenient
as it can be done in a few steps. Then, you can use it in your **Point of Sale app** to weigh your
products, which is helpful if their price are based on it.
A scale can be connected to the :abbr:`IoT (Internet of Things)` box on an Odoo database in a few
easy steps. After setup, the *Point of Sale* app can be used to weigh products, which is helpful if
their prices are calculated based on weight.
Connection
==========
To link the scale to the **IoT Box**, connect them with a cable.
To link the scale to the :abbr:`IoT (Internet of Things)` box, connect it with a :abbr:`USB
(Universal Serial Bus)` cable.
.. note::
In some cases, a serial to USB adapter may be needed.
In some cases, a serial port to :abbr:`USB (Universal Serial Bus)` adapter may be needed.
If your scale is `compatible with Odoo IoT Box <https://www.odoo.com/page/iot-hardware>`_, there
is no need to set up anything because it will be automatically detected as soon as it is connected.
If the scale is `compatible with Odoo IoT Box <https://www.odoo.com/page/iot-hardware>`_, there is
no need to set up anything because it will be automatically detected as soon as it is connected.
.. image:: scale/iot-choice.png
:align: center
:alt: IOT box auto detection.
You may need to restart the box and download your scales drivers from the box in some cases. To do
so, go to the *IoT Box Home Page* and click on *drivers list*. Then, click on load drivers.
The :abbr:`IoT (Internet of Things)` box may need to be restarted and the scale's drivers may need
to be downloaded to the box in some cases. To update the drivers, go to the :abbr:`IoT (Internet of
Things)` box homepage and click on :guilabel:`Drivers List`. Then, click on :guilabel:`Load
Drivers`.
.. image:: scale/driver-list.png
:align: center
:alt: View of the IoT box settings and driver list.
Use a Scale in Point of Sale
============================
If loading the drivers still doesn't allow for the scale to function, it may be that the scale is
not compatible with the Odoo :abbr:`IoT (Internet of Things)` box. In this case, a different scale
will need to be used.
To use the scale in your *Point of Sale* app, go to :menuselection:`Point of Sale --> Configuration
--> Point of Sale`, open the one you want to configure, then click on *Edit* and enable the *IoT
Box* feature.
Use a scale in a point of sale (POS) system
===========================================
.. image:: scale/iot-box-pos.png
:align: center
:alt: View of the IoT box feature inside of the PoS settings.
To use the scale in the *Point of Sale app*, go to :menuselection:`PoS app --> 3-Dot Menu on the PoS
--> Settings`, then enable the :abbr:`IoT (Internet of Things)` box feature. After this is complete,
the scale device can be set.
Now, choose the *IoT Box* in the dropdown menu and check the *Electronic Scale* option. Then, you
hit save.
Select the scale from the :guilabel:`Electronic Scale` drop-down menu. Then click :guilabel:`Save`
to save the changes, if required.
.. image:: scale/electronic-scale-feature.png
:align: center
:alt: List of the external tools that can be used with PoS and the IoT box.
The scale is now available in all your *PoS* sessions. Then, if a product has a price per weight
set, clicking on it on the *PoS* screen opens the scale screen, where the cashier can weigh the
product and add the correct price to the cart.
The scale is now available in all the :abbr:`PoS (Point of Sale)` sessions. Now, if a product has a
price per weight set, clicking on it on the :guilabel:`PoS` screen opens the scale screen, where the
cashier can weigh the product and add the correct price to the cart.
.. image:: scale/scale-view.png
:align: center
Binary file not shown.

Before

Width:  |  Height:  |  Size: 22 KiB

After

Width:  |  Height:  |  Size: 32 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 11 KiB

After

Width:  |  Height:  |  Size: 24 KiB

@@ -2,43 +2,47 @@
Connect a screen
================
In Odoo, an :abbr:`IoT (Internet of Things)` Box can be connected to a screen display. After being
connected, the screen can be used to display a :abbr:`PoS (Point of Sale)` order to a client.
In Odoo, an :abbr:`IoT (Internet of Things)` box can be connected to a screen display. After being
configured, the screen can be used to display a Point of Sale (PoS) order to a client.
.. image:: screen/screen-pos-client-display.png
:align: center
:alt: An example of a PoS (point of sale) order on a screen display.
.. figure:: screen/screen-pos-client-display.png
.. note::
Access the customer display from any other computer by going to the :abbr:`IoT (Internet of
Things)` Box homepage and clicking on the :guilabel:`POS Display` button.
An example of a PoS (point of sale) order on a screen display.
Access the customer display by going to the :abbr:`IoT (Internet of Things)` box homepage and
clicking on the :guilabel:`PoS Display` button. To get to the :abbr:`IoT (Internet of Things)` box
homepage, navigate to :menuselection:`IoT app --> IoT Boxes` and click on the :abbr:`IoT (Internet
of Things)` box homepage link.
Connection
==========
The way to connect the screen display to the :abbr:`IoT (Internet of Things)` Box differs depending
The way to connect the screen display to the :abbr:`IoT (Internet of Things)` box differs depending
on the model.
.. tabs::
.. tab:: IoT Box model 4
Connect up to two screens with Micro-HDMI cables on the side of the :abbr:`IoT (Internet of
Things)` Box. If two screens are connected, they can display distinct content (see usage
below).
Connect up to two screens with micro-HDMI cables on the side of the :abbr:`IoT (Internet of
Things)` box. If two screens are connected, they can display distinct content (see
:ref:`Screen Usage <iot/usage_screen>`).
.. tab:: IoT Box model 3
Connect the screen with an HDMI cable on the side of the :abbr:`IoT (Internet of Things)` Box.
Connect the screen with an HDMI cable on the side of the :abbr:`IoT (Internet of Things)` box.
.. seealso::
:ref:`See the Raspberry Pi Schema <iot/connect_schema>`.
.. important::
Screen(s) should be connected before the :abbr:`IoT (Internet of Things)` Box is switched on. If
Screen(s) should be connected before the :abbr:`IoT (Internet of Things)` box is switched on. If
it is already on, connect the screen(s), and then restart the :abbr:`IoT (Internet of Things)`
Box by unplugging it and plugging it back into its power source.
box by unplugging it for ten seconds and plugging it back into its power source.
.. warning::
The usage of HDMI/Micro-HDMI adapters may cause issues which will result in a blank, black screen
on the screen display. Cable usage is recommended.
The usage of HDMI/micro-HDMI adapters may cause issues which will result in a blank, black screen
on the screen display. Using the specific cable for the display connection is recommended.
If the connection was successful, the screen should display the :guilabel:`POS Client display`
screen.
@@ -46,57 +50,61 @@ screen.
.. image:: screen/screen-pos-client-display-no-order.png
:align: center
:alt: The default "POS Client Display" screen that appears when a screen display is successfully
connected to an IoT Box.
connected to an IoT box.
The screen should also appear in the list of :guilabel:`Displays` on the :abbr:`IoT (Internet of
Things)` Box homepage.
Things)` box homepage. Alternatively, the display can be seen by accessing :menuselection:`IoT app
--> Devices`.
.. image:: screen/screen-screen-name-example.png
:align: center
:alt: An example of a screen display name shown on the IoT Box homepage.
:alt: An example of a screen display name shown on the IoT Box Home Page.
.. note::
If no screen is detected, a default display named :guilabel:`Distant Display` will be used
instead.
If no screen is detected, a default display named :guilabel:`Distant Display` will be displayed
instead. This indicates that there is no hardware screen connected.
.. image:: screen/screen-no-screen.png
:align: center
:alt: The "Distant Display" screen name will be used if no screen is detected.
.. _iot/usage_screen:
Usage
=====
Show Point of Sales orders to customers
---------------------------------------
Show Point of Sale orders to customers
--------------------------------------
To use the screen in the :guilabel:`Point of Sale` app, go to :menuselection:`Point of Sale -->
Configuration --> Point of Sale`, open the desired screen, click on :guilabel:`Edit`, and enable the
:guilabel:`IoT Box Devices` feature.
To use the screen in the *Point of Sale app*, go to :menuselection:`Point of Sale -->
Configuration --> Point of Sale`, select a :abbr:`PoS (Point of Sale)`, click :guilabel:`Edit` if
necessary, and enable the :guilabel:`IoT Box` feature.
Now, select :guilabel:`IoT Box` in the drop-down menu and choose the screen in the
:guilabel:`Customer Display` option. Then, click :guilabel:`Save`.
Next, select the screen from the :guilabel:`Customer Display` drop-down menu. Then click
:guilabel:`Save`, if required.
.. image:: screen/screen-pos-screen-config.png
:align: center
:alt: Connect the screen display to the Point of Sale app.
.. image:: screen/screen-pos-screen-config.png
:align: center
:alt: Connect the screen display to the Point of Sale app.
The screen is now available for :abbr:`PoS (Point of Sale)` sessions. A "screen" icon will appear
in the top bar to inform the connection status with the screen.
The screen is now available for :abbr:`PoS (Point of Sale)` sessions. A screen icon will appear in
the menu at the top of the screen to indicate the screen's connection status.
.. image:: screen/screen-pos-icon.png
:align: center
:alt: The "screen" icon on the Point of Sale display shows the connection status with the
screen.
.. image:: screen/screen-pos-icon.png
:align: center
:alt: The "screen" icon on the Point of Sale display shows the connection status with the
screen.
The screen will automatically show the :abbr:`PoS (Point of Sale)` orders and update when changes
are performed on the order.
are made to the order.
.. image:: screen/screen-pos-client-display.png
:align: center
:alt: An example of a PoS order on a screen display.
Display a website
-----------------
Display a website on the screen
-------------------------------
Opening the screen form view at :menuselection:`IoT --> Devices --> (screen device)` allows the user
to choose a particular website URL to display on the screen with the :guilabel:`Screen URL` field.
Open the screen form view by accessing :menuselection:`IoT app --> Devices --> Customer Display`.
This allows the user to choose a particular website URL to display on the screen using the
:guilabel:`Display URL` field.
Binary file not shown.

Before

Width:  |  Height:  |  Size: 40 KiB

After

Width:  |  Height:  |  Size: 88 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 39 KiB

After

Width:  |  Height:  |  Size: 29 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 7.4 KiB

After

Width:  |  Height:  |  Size: 7.4 KiB