[MOV] documentation structure reorganization

This commit aims to improve the documentation's navigability by redefining some categories' purposes and titles. There is a redirection rule for each documentation page moved. This ensures that users won't have a 404 error message. task-3217827 closes odoo/documentation#8056 Signed-off-by: Jonathan Castillo (jcs) <jcs@odoo.com>
2024-03-04 12:02:08 +01:00
parent 7b5dba47a7
commit 32aafb08cb
553 changed files with 643 additions and 642 deletions
@@ -0,0 +1,82 @@
+================
+Connect a camera
+================
+
+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 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 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-dropdown.png
+   :align: center
+   :alt: Camera recognized on the IoT box.
+
+Link camera to quality control point in manufacturing process
+=============================================================
+
+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.
+
+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.
+
+.. image:: camera/control-point-device.png
+   :align: center
+   :alt: Setting up the device on the quality control point.
+
+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/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:`/applications/inventory_and_mrp/quality/quality_management/quality_control_points`
+   - :doc:`/applications/inventory_and_mrp/quality/quality_management/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`
@@ -0,0 +1,52 @@
+====================
+Connect a footswitch
+====================
+
+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, 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
+==========
+
+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 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-dropdown.png
+   :align: center
+   :alt: Footswitch recognized on the IoT box.
+
+Link a footswitch to a work center in the Odoo Manufacturing app
+================================================================
+
+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-example.png
+   :align: center
+   :alt: Footswitch trigger setup on the Odoo database.
+
+.. 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::
+   On the :guilabel:`Work Order` screen, a status graphic indicates whether the database is
+   correctly connected to the footswitch.
+
+.. seealso::
+   :ref:`workcenter_iot`
@@ -0,0 +1,92 @@
+==========================
+Connect a measurement tool
+==========================
+
+.. _iot/devices/measurement-tool:
+
+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.
+
+Find the list of supported devices here: `Supported devices
+<https://www.odoo.com/page/iot-hardware>`_.
+
+Connect with universal serial bus (USB)
+=======================================
+
+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 with bluetooth
+======================
+
+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.
+
+.. image:: measurement_tool/measurement-tool.jpeg
+   :align: center
+   :alt: Bluetooth indicator on measurement tool.
+
+
+Link a measurement tool to a quality control point in the manufacturing process
+===============================================================================
+
+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.
+
+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.
+
+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.
+
+.. 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.
+
+.. 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/quality/quality_management/quality_control_points`
+   - :doc:`../../../inventory_and_mrp/quality/quality_management/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`
@@ -0,0 +1,122 @@
+=================
+Connect a printer
+=================
+
+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 :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 the *IoT app* devices list.
+
+Link printer
+============
+
+Link printer to work orders
+---------------------------
+
+*Work Orders* can be linked to printers, via a quality control point, to print labels for
+manufactured products.
+
+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.
+
+.. 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
+
+.. 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.
+
+.. 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`.
+
+.. seealso::
+   - :doc:`/applications/inventory_and_mrp/quality/quality_management/quality_control_points`
+   - :doc:`/applications/inventory_and_mrp/quality/quality_management/quality_alerts`
+
+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.
+
+Now, each time :guilabel:`Print` is selected in the control panel, instead of downloading a PDF, a
+pop-up appears which displays all the printer(s) linked to the report. Then Odoo sends the report to
+the selected printer(s), and automatically prints it.
+
+.. seealso::
+   :doc:`POS Order Printing <../../../sales/point_of_sale/restaurant/kitchen_printing>`
+
+.. 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.
@@ -0,0 +1,58 @@
+===============
+Connect a scale
+===============
+
+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 :abbr:`IoT (Internet of Things)` box, connect it with a :abbr:`USB
+(Universal Serial Bus)` cable.
+
+.. note::
+   In some cases, a serial port to :abbr:`USB (Universal Serial Bus)` adapter may be needed.
+
+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.
+
+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.
+
+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.
+
+Use a scale in a point of sale (POS) system
+===========================================
+
+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.
+
+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 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
+   :alt: Electronic Scale dashboard view when no items are being weighed.
@@ -0,0 +1,110 @@
+================
+Connect a screen
+================
+
+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.
+
+.. figure:: screen/screen-pos-client-display.png
+
+   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
+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
+      :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.
+
+.. 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
+   it is already on, connect the screen(s), and then restart the :abbr:`IoT (Internet of Things)`
+   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. 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.
+
+.. 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.
+
+The screen should also appear in the list of :guilabel:`Displays` on the :abbr:`IoT (Internet of
+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 Home Page.
+
+.. note::
+   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 Sale orders to customers
+--------------------------------------
+
+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.
+
+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.
+
+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.
+
+The screen will automatically show the :abbr:`PoS (Point of Sale)` orders and update when changes
+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 on the screen
+-------------------------------
+
+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.