diff --git a/content/applications/inventory_and_mrp/manufacturing/management/using_work_centers.rst b/content/applications/inventory_and_mrp/manufacturing/management/using_work_centers.rst index 9c6a836ba..fb8d41ce2 100644 --- a/content/applications/inventory_and_mrp/manufacturing/management/using_work_centers.rst +++ b/content/applications/inventory_and_mrp/manufacturing/management/using_work_centers.rst @@ -75,6 +75,8 @@ to a work center. The following information will be displayed for each piece of :guilabel:`MTBF`, :guilabel:`MTTR`, and :guilabel:`Est. Next Failure` are all calculated automatically based on past failure data, if any exists. +.. _workcenter_iot: + Integrate IoT devices --------------------- diff --git a/content/applications/productivity/iot/config/connect.rst b/content/applications/productivity/iot/config/connect.rst index 1b1b472ba..218632c59 100644 --- a/content/applications/productivity/iot/config/connect.rst +++ b/content/applications/productivity/iot/config/connect.rst @@ -1,81 +1,181 @@ -=================================== -Connect an IoT Box to your database -=================================== +========================== +Connect an IoT box to Odoo +========================== -Install the Internet of Things (IoT) App on your Odoo Database. +An Internet of Things (IoT) box is a micro-computer device that allows for the connection of input +and output devices to an Odoo database. An :abbr:`IoT (Internet of Things)` box subscription is +required in order to use the :abbr:`IoT (Internet of Things)` box with a secured connection. A +computer is also required to set up the :abbr:`IoT (Internet of Things)` box. -.. image:: connect/connect01.png +.. seealso:: + `IoT Box FAQ `_ + +Begin the :abbr:`IoT (Internet of Things)` configuration process by :ref:`installing the IoT app +` on the Odoo database through the :menuselection:`Apps` application. + +.. image:: connect/install-iot-app.png :align: center + :alt: The Internet of Things (IoT) app on the Odoo database. -Go in the IoT App and click on Connect on the IoT Boxes page. +Next, after the *IoT app* is installed, navigate to :menuselection:`IoT app --> IoT Boxes`, and then +click on the :guilabel:`Connect` button located in the upper-left corner of the :menuselection:`IoT +Boxes` dashboard. -.. image:: connect/connect02.png +.. image:: connect/connect-iot.png :align: center + :alt: Connecting an IoT box to the Odoo database. -Follow the steps to connect your IoT Box. +There are two recommended ways to connect the :abbr:`IoT (Internet of Things)` box to the database +once the *IoT app* is installed. Follow the steps in either of the next two sections to connect the +:abbr:`IoT (Internet of Things)` box via :ref:`wired ethernet connection ` or +via :ref:`WiFi `. -.. image:: connect/connect03.png +.. image:: connect/connect-iot-box.png :align: center + :alt: Connection steps for a wired connection or WiFi connection. -Ethernet Connection +.. important:: + The disk image that the :abbr:`IoT (Internet of Things)` box SD card is formatted with is unique + to the version of the Odoo database that the :abbr:`IoT (Internet of Things)` box is running on. + Ensure that the :abbr:`IoT (Internet of Things)` box is :doc:`flashed ` with the + most up-to-date disk image. + +.. _iot_connect/ethernet: + +Ethernet connection =================== -#. Connect to the IoT Box all the devices that have to be connected with - cables (ethernet, usb devices, etc.). +The following is the process to connect the :abbr:`IoT (Internet of Things)` box via an ethernet +cable to the Odoo database (by way of the ethernet port; RJ-45). -#. Power on the IoT Box. +First, connect all wired devices to the :abbr:`IoT (Internet of Things)` box (ethernet, :abbr:`USB +(Universal Serial Bus)` devices, etc.). At minimum, an HDMI screen should be connected. Then, plug +the :abbr:`IoT (Internet of Things)` box into a power source. -#. Read the Pairing Code from a screen or a receipt printer connected to the IoT Box. +Immediately after the unit powers on and boots up, read the *pairing code* from the screen or from +the printout of a receipt printer connected to the :abbr:`IoT (Internet of Things)` box. - .. image:: connect/connect04.png - -#. Input the Pairing Code and click on the Pair button. +.. warning:: + By default, the :abbr:`IoT (Internet of Things)` box will display the *pairing code* for a + maximum of 5 minutes after the unit boots up. After 5 minutes, the *pairing code* will disappear + for security purposes and the :abbr:`IoT (Internet of Things)` box will need to be rebooted + manually by unplugging the unit from the power source for ten seconds and re-plugging it back in. .. note:: - Recent changes in modern web browsers forced us to modify the connection wizard. - If your screen is different from the screenshots, make sure that the - ``iot_pairing`` module is installed. + If no screen is attached to the :abbr:`IoT (Internet of Things)` box, then the *pairing code* can + be accessed from the :abbr:`IoT (Internet of Things)` box homepage by clicking on the + :guilabel:`POS Display` button. For instructions on how to access the :abbr:`IoT (Internet of + Things)` box homepage visit :ref:`iot_connect/token`. -WiFi Connection +On the computer, navigate to :menuselection:`IoT app --> IoT Boxes`, and then click on the +:guilabel:`Connect` button located in the upper-left corner of the the :menuselection:`IoT Boxes` +dashboard. Input the *pairing code* in the :guilabel:`Pairing Code` field and click on the +:guilabel:`Pair` button. The database will now link to the :abbr:`IoT (Internet of Things)` box and +it will appear on the :menuselection:`IoT Boxes` page. + +.. _iot_connect/wifi: + +WiFi connection =============== -#. Power on the IoT Box +The following is the process to connect the :abbr:`IoT (Internet of Things)` box via a WiFi +connection to the Odoo database. -#. Copy the token +First, ensure there is no ethernet cable plugged into the :abbr:`IoT (Internet of Things)` box. +Then, connect all wired devices to the :abbr:`IoT (Internet of Things)` box (:abbr:`USB (Universal +Serial Bus)` devices, etc.). - .. image:: connect/connect05.png +After connecting the devices, plug the :abbr:`IoT (Internet of Things)` box into to a power source. +On the computer, navigate to :menuselection:`IoT app --> IoT Boxes`, and then click on the +:guilabel:`Connect` button located in the upper-left corner of the the :menuselection:`IoT Boxes` +dashboard. Then copy the :guilabel:`Token` from the :guilabel:`WiFi connection` section as this will +later be used to link the Odoo database to the :abbr:`IoT (Internet of Things)` box. -#. Connect to the IoT Box WiFi Network (make sure there is no ethernet - cable plugged in your computer). +Back on the computer, navigate to the available WiFi networks and connect to the :abbr:`IoT +(Internet of Things)` box WiFi network. The WiFi network dispersed by the :abbr:`IoT (Internet of +Things)` box will start with `IoTBox-xxxxxxxxxx`. - .. image:: connect/connect06.png - -#. You will be redirected to the IoT Box Homepage (if it doesn't work, - connect to the IP address of the box). Give a name to your IoT Box (not - required) and paste the token, then click on next. - - .. image:: connect/connect07.png - - .. tip:: - If you are on Runbot, do not forget to add the -all or -base in the - token (e.g. this token - **http://375228-saas-11-5-iot-f3f920.runbot16.odoo.com\|4957098401** - should become - **http://375228-saas-11-5-iot-f3f920-all.runbot16.odoo.com\|4957098401**). - -#. Choose the WiFi network you want to connect with (enter the password - if there is one) and click on Submit. Wait a few seconds before being - redirected to your database. - - .. image:: connect/connect08.png - -You should now see the IoT Box. - -.. image:: connect/connect09.png +.. image:: connect/connect-iot-wifi.png :align: center + :alt: WiFi networks available on the computer. -IoT Box Schema +Upon connecting to the :abbr:`IoT (Internet of Things)` box WiFi, a browser will automatically +redirect to the :menuselection:`Configure Iot Box` wizard. Name the :abbr:`IoT (Internet of Things)` +box, then paste the previously copied *token* into the :guilabel:`Server Token` field, and then +click on :guilabel:`Next`. + +.. image:: connect/server-token.png + :align: center + :alt: Enter the server token into the IoT box. + +.. note:: + If the :abbr:`IoT (Internet of Things)` box WiFi connection wizard doesn't start, then see the + documentation on :ref:`connecting with a token `. + +Now, choose the WiFi network that the :abbr:`IoT (Internet of Things)` box will connect with (enter +the password if there is one) and click on :guilabel:`Connect`. Wait a few seconds and the browser +will redirect to the :abbr:`IoT (Internet of Things)` box homepage. The computer may need to be +manually re-connected back to the original WiFi connection, if this does not happen automatically. + +.. image:: connect/configure-wifi-network-iot.png + :align: center + :alt: Configuring the WiFi for the IoT box. + +After completing each step, the :abbr:`IoT (Internet of Things)` box should appear when navigating +to :menuselection:`IoT app --> IoT Boxes` on the Odoo database. + +.. image:: connect/iot-box-connected.png + :align: center + :alt: The IoT box has been successfully configured on the Odoo database. + +.. important:: + The :abbr:`IoT (Internet of Things)` box may need to be manually rebooted upon successfully + connecting via WiFi for the box to appear in the *IoT app* on the Odoo database. To do so, simply + unplug the device and plug it back into the power source after ten seconds. + +.. _iot_connect/token: + +Manually connecting the IoT box using the token +=============================================== + +A manual connection of the :abbr:`IoT (Internet of Things)` box to the :abbr:`IoT (Internet of +Things)` app can be made using the *token*, from a computer. The *token* can be found by navigating +to :menuselection:`IoT app --> IoT Boxes` and clicking on :guilabel:`Connect`. + +Under the :guilabel:`WiFi Connection` section of the :guilabel:`Connect an IoT Box` page that +appears, click :guilabel:`Copy` to the right of the :guilabel:`Token`. This token will be entered +into the :abbr:`IoT (Internet of Things)` box homepage. + +Access the :abbr:`IoT (Internet of Things)` box homepage by entering the :abbr:`IP (Internet +Protocol)` address of the :abbr:`IoT (Internet of Things)` box into a browser window from a computer +on the same network as the :abbr:`IoT (Internet of Things)` box (preferably by ethernet connection). + +.. note:: + The :abbr:`IP (Internet Protocol)` address can be accessed by the router admin console that the + :abbr:`IoT (Internet of Things)` box is connected to, or by connecting a receipt printer to the + :abbr:`IoT (Internet of Things)` box. A receipt will print out with the :abbr:`IoT (Internet of + Things)` box's :abbr:`IP (Internet Protocol)` address on it. + +On the :abbr:`IoT (Internet of Things)` box homepage, enter the *token* under the :guilabel:`Server` +section by clicking on :guilabel:`Configure`. Then, paste the *token* into the :guilabel:`Server +Token` field and click :guilabel:`Connect`. The :abbr:`IoT (Internet of Things)` box will then link +to the Odoo database. + +.. _iot/connect_schema: + +IoT box schema ============== -.. image:: connect/connect10.png - :align: center +Raspberry Pi 4 +-------------- + +.. figure:: connect/iot-box-schema.png + + The Odoo IoT box (Raspberry Pi 4) schema with labels. + +Raspberry Pi 3 +-------------- + +.. figure:: connect/iox-box-schema-3.png + + The Odoo IoT box (Raspberry Pi 3) schema with labels. diff --git a/content/applications/productivity/iot/config/connect/configure-wifi-network-iot.png b/content/applications/productivity/iot/config/connect/configure-wifi-network-iot.png new file mode 100644 index 000000000..3fd18b14f Binary files /dev/null and b/content/applications/productivity/iot/config/connect/configure-wifi-network-iot.png differ diff --git a/content/applications/productivity/iot/config/connect/connect-iot-box.png b/content/applications/productivity/iot/config/connect/connect-iot-box.png new file mode 100644 index 000000000..1ff0c969f Binary files /dev/null and b/content/applications/productivity/iot/config/connect/connect-iot-box.png differ diff --git a/content/applications/productivity/iot/config/connect/connect-iot-wifi.png b/content/applications/productivity/iot/config/connect/connect-iot-wifi.png new file mode 100644 index 000000000..660a5836d Binary files /dev/null and b/content/applications/productivity/iot/config/connect/connect-iot-wifi.png differ diff --git a/content/applications/productivity/iot/config/connect/connect-iot.png b/content/applications/productivity/iot/config/connect/connect-iot.png new file mode 100644 index 000000000..f4acfa768 Binary files /dev/null and b/content/applications/productivity/iot/config/connect/connect-iot.png differ diff --git a/content/applications/productivity/iot/config/connect/connect02.png b/content/applications/productivity/iot/config/connect/connect02.png deleted file mode 100644 index ef65c4911..000000000 Binary files a/content/applications/productivity/iot/config/connect/connect02.png and /dev/null differ diff --git a/content/applications/productivity/iot/config/connect/connect03.png b/content/applications/productivity/iot/config/connect/connect03.png deleted file mode 100644 index 27b0ea912..000000000 Binary files a/content/applications/productivity/iot/config/connect/connect03.png and /dev/null differ diff --git a/content/applications/productivity/iot/config/connect/connect04.png b/content/applications/productivity/iot/config/connect/connect04.png deleted file mode 100644 index 18a37f300..000000000 Binary files a/content/applications/productivity/iot/config/connect/connect04.png and /dev/null differ diff --git a/content/applications/productivity/iot/config/connect/connect05.png b/content/applications/productivity/iot/config/connect/connect05.png deleted file mode 100644 index b9b7fedc5..000000000 Binary files a/content/applications/productivity/iot/config/connect/connect05.png and /dev/null differ diff --git a/content/applications/productivity/iot/config/connect/connect06.png b/content/applications/productivity/iot/config/connect/connect06.png deleted file mode 100644 index b07817412..000000000 Binary files a/content/applications/productivity/iot/config/connect/connect06.png and /dev/null differ diff --git a/content/applications/productivity/iot/config/connect/connect07.png b/content/applications/productivity/iot/config/connect/connect07.png deleted file mode 100644 index e1fa3e23d..000000000 Binary files a/content/applications/productivity/iot/config/connect/connect07.png and /dev/null differ diff --git a/content/applications/productivity/iot/config/connect/connect08.png b/content/applications/productivity/iot/config/connect/connect08.png deleted file mode 100644 index e5dcedc84..000000000 Binary files a/content/applications/productivity/iot/config/connect/connect08.png and /dev/null differ diff --git a/content/applications/productivity/iot/config/connect/connect09.png b/content/applications/productivity/iot/config/connect/connect09.png deleted file mode 100644 index 7022ed331..000000000 Binary files a/content/applications/productivity/iot/config/connect/connect09.png and /dev/null differ diff --git a/content/applications/productivity/iot/config/connect/connect10.png b/content/applications/productivity/iot/config/connect/connect10.png deleted file mode 100644 index 602ac5834..000000000 Binary files a/content/applications/productivity/iot/config/connect/connect10.png and /dev/null differ diff --git a/content/applications/productivity/iot/config/connect/connect01.png b/content/applications/productivity/iot/config/connect/install-iot-app.png similarity index 100% rename from content/applications/productivity/iot/config/connect/connect01.png rename to content/applications/productivity/iot/config/connect/install-iot-app.png diff --git a/content/applications/productivity/iot/config/connect/iot-box-connected.png b/content/applications/productivity/iot/config/connect/iot-box-connected.png new file mode 100644 index 000000000..d51a5c085 Binary files /dev/null and b/content/applications/productivity/iot/config/connect/iot-box-connected.png differ diff --git a/content/applications/productivity/iot/config/connect/iot-box-schema.png b/content/applications/productivity/iot/config/connect/iot-box-schema.png new file mode 100644 index 000000000..41e99c8de Binary files /dev/null and b/content/applications/productivity/iot/config/connect/iot-box-schema.png differ diff --git a/content/applications/productivity/iot/config/connect/iox-box-schema-3.png b/content/applications/productivity/iot/config/connect/iox-box-schema-3.png new file mode 100644 index 000000000..3d9319e19 Binary files /dev/null and b/content/applications/productivity/iot/config/connect/iox-box-schema-3.png differ diff --git a/content/applications/productivity/iot/config/connect/server-token.png b/content/applications/productivity/iot/config/connect/server-token.png new file mode 100644 index 000000000..d041790a9 Binary files /dev/null and b/content/applications/productivity/iot/config/connect/server-token.png differ diff --git a/content/applications/productivity/iot/config/flash_sdcard.rst b/content/applications/productivity/iot/config/flash_sdcard.rst index cef0d4493..7891f3f2c 100644 --- a/content/applications/productivity/iot/config/flash_sdcard.rst +++ b/content/applications/productivity/iot/config/flash_sdcard.rst @@ -1,37 +1,68 @@ -===================== -Flashing your SD Card -===================== +==================== +Flashing the SD card +==================== -In some case, you may need to reflash your IoT Box’s SD Card to benefit -from our latest updates. +In some circumstances, the :abbr:`IoT (Internet of Things)` box's micro SD Card may need to be +re-flashed to benefit from Odoo's latest :abbr:`IoT (Internet of Things)` image update. This means +that the Odoo :abbr:`IoT (Internet of Things)` box software may need to be updated. -Upgrade from the IoT Box homepage -================================= +Upgrade from the IoT box home page +================================== -Go to the IoT Box homepage, click on *Update*, next to the version number. -If a new version of the IoT Box image is available, you will see a -*Upgrade to ___* button a the bottom of the page, the IoT Box will then -flash itself to the new version of the IoT Box. All of your configurations -will be saved. +Go to the :abbr:`IoT (Internet of Things)` box homepage by navigating to :menuselection:`IoT app --> +IoT Boxes` and clicking on the :guilabel:`IP address` of the :abbr:`IoT (Internet of Things)` box. +Then click on :guilabel:`Update` (next to the version number). + +If a new version of the :abbr:`IoT (Internet of Things)` Box image is available, an +:guilabel:`Upgrade to _xx.xx_` button will appear at the bottom of the page. Click this button to +upgrade the unit and the :abbr:`IoT (Internet of Things)` box will then flash itself to the new +version. All of the previous configurations will be saved. .. note:: - This process can take more than 30 minutes. Do not turn off or unplug - the IoT Box as it would leave it in an inconsistent state. + This process can take more than 30 minutes. Do not turn off or unplug the :abbr:`IoT (Internet of + Things)` box as it would leave it in an inconsistent state. This means that the :abbr:`IoT + (Internet of Things)` box will need to be re-flashed with a new image. See + :ref:`flash_sdcard/etcher`. -.. image:: flash_sdcard/flash_sdcard01.png +.. image:: flash_sdcard/flash-upgrade.png :align: center + :alt: IoT box software upgrade in the IoT Box Home Page. -Upgrade with Etcher -=================== +.. _flash_sdcard/etcher: -Go to Balena’s website and download `Etcher `__. -It’s a free and open-source utility used for burning image files. -Install and launch it. Download the latest image from `nightly -`__. +Upgrade with Etcher Software +============================ -Then, open *Etcher* and select *Flash from file*, find the image you just -downloaded. Insert the IoT Box SD card into your computer and select it. -Click on *Flash* and wait for the process to finish. +.. note:: + A computer with a micro SD card reader/adapter is required in order to re-flash the micro SD + card. -.. image:: flash_sdcard/flash_sdcard02.png +Navigate to Balena's website and download `Etcher `_. It's a free and +open-source utility used for burning image files onto drives. Click to `download +`_. Install and launch the program on the computer. + +Then download the version-specific :abbr:`IoT (Internet of Things)` image from `nightly +`_. + +The following are image versions on the `nightly `_ website +with their corresponding Odoo database version: + +- Odoo V16 --> iotbox-latest.zip +- Odoo V15 --> iotboxv21_10.zip +- Odoo V14 --> iotboxv21_04.zip +- Odoo V13 --> iotboxv20_10.zip + +The images should be downloaded and extracted to a convenient file location. + +After this step is complete, insert the :abbr:`IoT (Internet of Things)` box's micro SD card into +the computer or reader. Open *Etcher* and select :guilabel:`Flash from file`, then find and select +the image just downloaded and extracted. Next, select the drive the image should be burned to. +Lastly, click on :guilabel:`Flash` and wait for the process to finish. + +.. image:: flash_sdcard/etcher-app.png :align: center + :alt: Balena's Etcher software dashboard. + +.. note:: + An alternative software for flashing the micro SD card is *Raspberry Pi Imager*. Download the + *Raspberry Pi* software `here `_. diff --git a/content/applications/productivity/iot/config/flash_sdcard/etcher-app.png b/content/applications/productivity/iot/config/flash_sdcard/etcher-app.png new file mode 100644 index 000000000..2163de85f Binary files /dev/null and b/content/applications/productivity/iot/config/flash_sdcard/etcher-app.png differ diff --git a/content/applications/productivity/iot/config/flash_sdcard/flash-upgrade.png b/content/applications/productivity/iot/config/flash_sdcard/flash-upgrade.png new file mode 100644 index 000000000..344cd2aa3 Binary files /dev/null and b/content/applications/productivity/iot/config/flash_sdcard/flash-upgrade.png differ diff --git a/content/applications/productivity/iot/config/flash_sdcard/flash_sdcard01.png b/content/applications/productivity/iot/config/flash_sdcard/flash_sdcard01.png deleted file mode 100644 index 0bb353383..000000000 Binary files a/content/applications/productivity/iot/config/flash_sdcard/flash_sdcard01.png and /dev/null differ diff --git a/content/applications/productivity/iot/config/flash_sdcard/flash_sdcard02.png b/content/applications/productivity/iot/config/flash_sdcard/flash_sdcard02.png deleted file mode 100644 index 08e4c1b25..000000000 Binary files a/content/applications/productivity/iot/config/flash_sdcard/flash_sdcard02.png and /dev/null differ diff --git a/content/applications/productivity/iot/config/pos.rst b/content/applications/productivity/iot/config/pos.rst index 590640ebe..715da84aa 100644 --- a/content/applications/productivity/iot/config/pos.rst +++ b/content/applications/productivity/iot/config/pos.rst @@ -1,67 +1,67 @@ -=========================== -Use the IoT Box for the PoS -=========================== - -.. image:: pos/pos01.png - :align: center +========================= +Use an IoT box with a PoS +========================= Prerequisites ============= -Before starting, make sure you have the following: +Before starting, make sure the following equipment is available: -- An IoT Box, with its power adapter. +- An :abbr:`IoT (Internet of Things)` box, with its power adapter. +- A computer or tablet with an up-to-date web browser. +- Odoo Online or an Odoo instance with the *Point of Sale* and *IoT* applications installed. +- A local network set up with :abbr:`DHCP (Dynamic Host Configuration Protocol)` (this is the + default setting). +- An RJ45 Ethernet Cable (optional, but preferred over WiFi, which is already built in). +- Any of the supported hardware (receipt printer, barcode scanner, cash drawer, payment terminal, + scale, customer display, etc.). The list of supported hardware can be found on the `POS Hardware + page `_. -- A computer or tablet with an up-to-date web browser +Setup +===== -- A running Odoo Online or Odoo instance with the Point of Sale and IoT apps - installed +.. figure:: pos/pos-connections.png -- A local network setup with DHCP (this is the default setting) + A suggested configuration for a point of sale system. -- An RJ45 Ethernet Cable (optional, WiFi is built in) +To connect hardware to the :abbr:`PoS (Point of Sale)`, the first step is to connect an :abbr:`IoT +(Internet of Things)` box to the database. To do this, follow these instructions: :doc:`Connect an +Internet of Things (IoT) box to the Odoo database `. -- Any of the supported hardware (receipt printer, barcode scanner, - cash drawer, payment terminal, scale, customer display, etc.). - The list of supported hardware can be found on the `POS Hardware - page `__ +Then, connect the peripheral devices to the :abbr:`IoT (Internet of Things)` box. -Set Up -====== +.. list-table:: + :header-rows: 1 + :stub-columns: 1 -To connect hardware to the PoS, the first step is to connect an IoT Box -to your database. For this, follow this -:doc:`documentation `. + * - Device Name + - Instructions + * - Printer + - Connect a supported receipt printer to a :abbr:`USB (Universal Serial Bus)` port or + to the network, and power it on. Refer to + :doc:`/applications/sales/point_of_sale/restaurant/kitchen_printing`. + * - Cash drawer + - The cash drawer should be connected to the printer with an RJ25 cable. + * - Barcode scanner + - In order for the barcode scanner to be compatible it must end barcodes with an `ENTER` + character (keycode 28). This is most likely the default configuration of the barcode scanner. + * - Scale + - Connect the scale and power it on. Refer to + :doc:`/applications/productivity/iot/devices/scale`. + * - Customer display + - Connect a screen to the :abbr:`IoT (Internet of Things)` box to display the :abbr:`PoS (Point + of Sale)` order. Refer to :doc:`/applications/productivity/iot/devices/screen`. + * - Payment terminal + - The connection process depends on the terminal. Refer to the :doc:`payment terminals + documentation `. -Then, you have to connect the peripheral devices to your IoT Box. +Once this is completed, connect the :abbr:`IoT (Internet of Things)` box to the :menuselection:`PoS` +application. To do this, go to :menuselection:`Point of Sale --> Configuration --> PoS`, tick the +:guilabel:`IoT Box` option, and select the devices to be used in this :abbr:`PoS (Point of Sale)`. +:guilabel:`Save` the the changes. -- **Printer**: Connect a supported receipt printer to a USB port or to - the network and power it on. - -- **Cash drawer**: The cash drawer should be connected to the printer - with an RJ25 cable. - -- **Barcode scanner**: Connect your barcode scanner. In order for your - barcode scanner to be compatible it must end barcodes with an Enter - character (keycode 28). This is most likely the default configuration - of your barcode scanner. - -- **Scale**: Connect your scale and power it on. - -- **Customer Display**: Connect a screen to the IoT Box to display the - PoS order. Please refer to - :doc:`/applications/productivity/iot/devices/screen`. - -- **Payment terminal**: The connection process depends on the terminal, - please refer to the :doc:`payment terminals documentation - `. - -Once it's done, you can connect the IoT Box to your PoS. For this, go in -:menuselection:`Point of Sale --> Configuration --> PoS`, tick *IoT Box* -and select the devices you want to use in this Point of Sale. Save the -changes. - -.. image:: pos/pos02.png +.. image:: pos/iot-connected-devices.png :align: center + :alt: Configuring the connected devices in the POS application. -Set up is done, you can launch a new PoS Session. +Once set up is done, a new :abbr:`PoS (Point of Sale)` session can be launched. diff --git a/content/applications/productivity/iot/config/pos/iot-connected-devices.png b/content/applications/productivity/iot/config/pos/iot-connected-devices.png new file mode 100644 index 000000000..bbd116b59 Binary files /dev/null and b/content/applications/productivity/iot/config/pos/iot-connected-devices.png differ diff --git a/content/applications/productivity/iot/config/pos/pos-connections.png b/content/applications/productivity/iot/config/pos/pos-connections.png new file mode 100644 index 000000000..af3eebc75 Binary files /dev/null and b/content/applications/productivity/iot/config/pos/pos-connections.png differ diff --git a/content/applications/productivity/iot/config/pos/pos01.png b/content/applications/productivity/iot/config/pos/pos01.png deleted file mode 100644 index a8cf13a07..000000000 Binary files a/content/applications/productivity/iot/config/pos/pos01.png and /dev/null differ diff --git a/content/applications/productivity/iot/config/pos/pos02.png b/content/applications/productivity/iot/config/pos/pos02.png deleted file mode 100644 index abb964a6c..000000000 Binary files a/content/applications/productivity/iot/config/pos/pos02.png and /dev/null differ diff --git a/content/applications/productivity/iot/config/troubleshooting.rst b/content/applications/productivity/iot/config/troubleshooting.rst index ecd655755..c1187796e 100644 --- a/content/applications/productivity/iot/config/troubleshooting.rst +++ b/content/applications/productivity/iot/config/troubleshooting.rst @@ -2,133 +2,156 @@ Troubleshooting =============== -IoT Box Connection +IoT box connection ================== -I can't find the pairing code to connect my IoT Box ---------------------------------------------------- +Unable to locate the pairing code to connect the IoT box +-------------------------------------------------------- -The pairing code should be printed on receipt printers connected to the -IoT Box and should also be displayed on connected monitors. +The pairing code should be printed on receipt printers connected to the :abbr:`IoT (Internet of +Things)` box and should also be displayed on connected monitors. The pairing code doesn't show under the following circumstances: -- The IoT Box is already connected to an Odoo database; +- The :abbr:`IoT (Internet of Things)` box is already connected to an Odoo database. +- The :abbr:`IoT (Internet of Things)` box is not connected to the Internet. +- The code is only valid for 5 minutes after the :abbr:`IoT (Internet of Things)` box has started. + It's automatically removed from connected displays when this time has expired. +- The version of the :abbr:`IoT (Internet of Things)` box image is too old. If the :abbr:`IoT + (Internet of Things)` box image is from an earlier version, then the SD card of the :abbr:`IoT + (Internet of Things)` box will need to be re-flashed to update the image (see :doc:`Flashing the + SD Card `). -- The IoT Box is not connected to the Internet; +If none of the cases listed above correct the issue, then make sure that the :abbr:`IoT (Internet of +Things)` box has correctly started, by checking that a fixed green LED is showing next to the power +port. -- The code is only valid for 5 minutes after the IoT Box has started. It's - automatically removed from connected displays when this delay has expired; +IoT box is connected but it's not showing in the database +--------------------------------------------------------- -- The version of the IoT Box image is too old. It should use version 20.06 - or more recent. If your IoT Box image is from an earlier version, then - you will have to reflash the SD card of your IoT Box to update the image - (see :doc:`Flashing your SD Card `) +When an :abbr:`IoT (Internet of Things)` box connects to a database, it may restart. If so, it can +take up to five minutes before appearing in the database. If the :abbr:`IoT (Internet of Things)` +box is still not showing after five minutes, make sure that the :abbr:`IoT (Internet of Things)` box +can reach the database and that the server doesn't use a multi-database environment. -If you are not in any of the cases listed above, make sure that the IoT Box -has correctly started, by checking that a fixed green LED is showing next to -the micro-USB port. +To access the database from the :abbr:`IoT (Internet of Things)` box, open a browser and type in the +database address. -I've connected my IoT Box but it's not showing in my database -------------------------------------------------------------- +The IoT box is connected to the Odoo database, but cannot be reached +-------------------------------------------------------------------- -When you connect an IoT Box to a database, the IoT Box might restart, if -that is the case, it might take up to one minute before appearing in your -database. If after some time the IoT is still not showing, make sure that -your database can be reached from the IoT Box and that your server doesn't -use a multi-database environment. +Make sure that the :abbr:`IoT (Internet of Things)` box and the computer running the browser are +located on the same network, as the :abbr:`IoT (Internet of Things)` box cannot be reached from +outside the local network. -My IoT Box is connected to my database, but cannot be reached -------------------------------------------------------------- +The HTTPS certificate doesn't generate +-------------------------------------- -Make sure that the IoT Box and the device running the browser are located -on the same network as the IoT Box cannot be reached from outside the local -network. +In order to generate a :abbr:`HTTPS (Hypertext Transfer Protocol Secure)` certificate, an IoT box +subscription is required for the :abbr:`IoT (Internet of Things)` box. Connecting the :abbr:`IoT +(Internet of Things)` box prior to configuring an :abbr:`IoT (Internet of Things)` subscription for +the database and :abbr:`IoT (Internet of Things)` box with the Account Manager will result in an +unsecured connection. + +In addition, a firewall can also prevent the :abbr:`HTTPS (Hypertext Transfer Protocol Secure)` +certificate from generating correctly. In this case, deactivate the firewall until the certificate +is successfully generated. It should also be noted that certain devices, such as a router that has +a built-in firewall, can prevent the :abbr:`HTTPS (Hypertext Transfer Protocol Secure)` certificate +from generating. + +.. seealso:: + :doc:`HTTPS certificate (IoT) ` Printer ======= -My printer is not detected --------------------------- +The printer is not detected +--------------------------- -If one of your printers doesn't show up in your devices list, go to the -IoT Box homepage and make sure that it is listed under *Printers*. +If a printer doesn't show up in the devices list, go to the :abbr:`IoT (Internet of Things)` box +homepage and make sure that it is listed under :guilabel:`Printers`. -.. image:: troubleshooting/troubleshooting_printer_01.png +.. image:: troubleshooting/printer-status.png :align: center + :alt: The IoT box Home Page landing page. -If your printer is not present on the IoT Box homepage, hit -*Printers Server*, go to the *Administration* tab and click on -*Add Printer*. If you can't find your printer in the list, it's probably -not connected properly. +If the printer is not present on the :abbr:`IoT (Internet of Things)` box homepage, click +:guilabel:`Printers Server`, go to the :guilabel:`Administration` tab and click on :guilabel:`Add +Printer`. If the printer is not present in the list, it's likely not connected properly. -My printer outputs random text ------------------------------- +The printer outputs random text +------------------------------- -For most printers, the correct driver should be automatically detected -and selected. However, in some cases, the automatic detection mechanism -might not be enough, and if no driver is found the printer might print -random characters. +For most printers, the correct driver should be automatically detected and selected. However, in +some cases, the automatic detection mechanism might not be enough, and if no driver is found, the +printer might print random characters. -The solution is to manually select the corresponding driver. On the IoT -Box homepage, click on *Printers Server*, go to the *Printers* -tab and select the printer in the list. In the Administration dropdown, -click on *Modify Printer*. Follow the steps and select the Make and Model -corresponding to your printer. +The solution is to manually select the corresponding driver. On the :abbr:`IoT (Internet of Things)` +box homepage, click on :guilabel:`Printers Server`, go to the :guilabel:`Printers` tab and select +the printer in the list. In the :guilabel:`Administration` dropdown, click on :guilabel:`Modify +Printer`. Follow the steps and select the *make* and *model* corresponding to the printer. -.. image:: troubleshooting/troubleshooting_printer_02.png +.. image:: troubleshooting/modify-printer.png :align: center + :alt: Edit the printer connected to the IoT box. .. note:: - Epson and Star receipt printers and Zebra label printers do not - need a driver to work. Make sure that no driver is selected for those - printers. + Epson and Star receipt printers and Zebra label printers do not need a driver to work. Make sure + that no driver is selected for those printers. -My Zebra Printer doesn't print anything ---------------------------------------- +The Zebra printer doesn't print anything +---------------------------------------- -Zebra printers are quite sensitive to the format of the ZPL code that is -printed. If nothing comes out of the printer or blank labels are printed, -try changing the format of the report that is sent to the printer by -accessing :menuselection:`Settings ~~> Technical ~~> Views` in developer -mode and look for the corresponding template. +Zebra printers are quite sensitive to the format of the Zebra Programming Language (ZPL) code that +is printed. If nothing comes out of the printer or blank labels are printed, try changing the format +of the report that is sent to the printer by accessing :menuselection:`Settings --> Technical --> +User Interface --> Views` in :ref:`developer mode ` and look for the corresponding +template. -Barcode Scanner +.. seealso:: + Check out Zebra's instructions on printing :abbr:`ZPL (Zebra Programming Language)` files + `here + `_. + +Barcode scanner =============== The characters read by the barcode scanner don't match the barcode ------------------------------------------------------------------ -By default, we assume that your barcode scanner is configured in US -QWERTY. This is the default configuration of most barcode readers. -If your barcode scanner uses a different layout, please go to the -form view of your device and select the correct one. +By default, most barcode scanners are configured in the US QWERTY format. If the barcode scanner +uses a different layout, go to the form view of the device (:menuselection:`IoT App --> Devices --> +Barcode Device`) and select the correct format. Nothing happens when a barcode is scanned ----------------------------------------- -Make sure that the correct device is selected in your Point of Sale -configuration and that your barcode is configured to send an ENTER -character (keycode 28) at the end of every barcode. +Make sure that the correct device is selected in the :menuselection:`Point of Sale` configuration +and that the barcode is configured to send an `ENTER` character (keycode 28) at the end of every +barcode. To do so, navigate to :menuselection:`PoS app --> 3-Dot Menu on the PoS --> IoT Box section +--> Edit`. The barcode scanner is detected as a keyboard --------------------------------------------- -Some poorly built barcode scanners do not advertise themselves as -barcode scanners but as a USB keyboard instead, and will not be -recognized by the IoT Box. +.. important:: + Some barcode scanners do not advertise themselves as barcode scanners but as a USB keyboard + instead, and will not be recognized by the :abbr:`IoT (Internet of Things)` box. -You can manually change the device type by going to its form view and -activating the *Is scanner* option. +The device type can be manually changed by going to its form view (:menuselection:`IoT App --> +Devices --> Barcode Device`) and activating the :guilabel:`Is scanner` option. -.. image:: troubleshooting/troubleshooting_barcode_01.png +.. image:: troubleshooting/barcode-scanner-settings.png :align: center + :alt: Modifying the form view of the barcode scanner. -Cashdrawer -========== +Cash drawer +=========== -The cashdrawer does not open ----------------------------- +The cash drawer does not open +----------------------------- -The cashdrawer should be connected to the printer and the *Cashdrawer* -checkbox should be ticked in the POS configuration. +The cash drawer should be connected to the printer and the :guilabel:`Cash drawer` checkbox should +be ticked in the :abbr:`PoS (Point of Sale)` configuration. To do so, navigate to +:menuselection:`POS app --> 3-Dot Menu on the POS --> IoT Box section --> Edit --> Receipt Printer +--> Cashdrawer checkbox`. diff --git a/content/applications/productivity/iot/config/troubleshooting/troubleshooting_barcode_01.png b/content/applications/productivity/iot/config/troubleshooting/barcode-scanner-settings.png similarity index 100% rename from content/applications/productivity/iot/config/troubleshooting/troubleshooting_barcode_01.png rename to content/applications/productivity/iot/config/troubleshooting/barcode-scanner-settings.png diff --git a/content/applications/productivity/iot/config/troubleshooting/troubleshooting_printer_02.png b/content/applications/productivity/iot/config/troubleshooting/modify-printer.png similarity index 100% rename from content/applications/productivity/iot/config/troubleshooting/troubleshooting_printer_02.png rename to content/applications/productivity/iot/config/troubleshooting/modify-printer.png diff --git a/content/applications/productivity/iot/config/troubleshooting/troubleshooting_printer_01.png b/content/applications/productivity/iot/config/troubleshooting/printer-status.png similarity index 100% rename from content/applications/productivity/iot/config/troubleshooting/troubleshooting_printer_01.png rename to content/applications/productivity/iot/config/troubleshooting/printer-status.png diff --git a/content/applications/productivity/iot/devices/camera.rst b/content/applications/productivity/iot/devices/camera.rst index 2061e2c1c..e211016c3 100644 --- a/content/applications/productivity/iot/devices/camera.rst +++ b/content/applications/productivity/iot/devices/camera.rst @@ -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* `__, there is no need to -set up anything as it will be detected as soon as it is connected. +If the camera is `supported `_, 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` diff --git a/content/applications/productivity/iot/devices/camera/camera_01.png b/content/applications/productivity/iot/devices/camera/camera-dropdown.png similarity index 100% rename from content/applications/productivity/iot/devices/camera/camera_01.png rename to content/applications/productivity/iot/devices/camera/camera-dropdown.png diff --git a/content/applications/productivity/iot/devices/camera/camera_03.png b/content/applications/productivity/iot/devices/camera/camera_03.png deleted file mode 100644 index 59cdf042a..000000000 Binary files a/content/applications/productivity/iot/devices/camera/camera_03.png and /dev/null differ diff --git a/content/applications/productivity/iot/devices/camera/control-point-device.png b/content/applications/productivity/iot/devices/camera/control-point-device.png new file mode 100644 index 000000000..05a7666ae Binary files /dev/null and b/content/applications/productivity/iot/devices/camera/control-point-device.png differ diff --git a/content/applications/productivity/iot/devices/camera/camera_04.png b/content/applications/productivity/iot/devices/camera/serial-number-picture.png similarity index 100% rename from content/applications/productivity/iot/devices/camera/camera_04.png rename to content/applications/productivity/iot/devices/camera/serial-number-picture.png diff --git a/content/applications/productivity/iot/devices/footswitch.rst b/content/applications/productivity/iot/devices/footswitch.rst index c30e3347b..59c5bd534 100644 --- a/content/applications/productivity/iot/devices/footswitch.rst +++ b/content/applications/productivity/iot/devices/footswitch.rst @@ -1,42 +1,52 @@ ==================== -Connect a Footswitch +Connect a footswitch ==================== -When working, it is always better to have your two hands available. -Using Odoo’s *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 `__, there is no need to -set up anything since it will be automatically detected when connected. +If the footswitch is a `supported device `_, 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` diff --git a/content/applications/productivity/iot/devices/footswitch/footswitch_01.png b/content/applications/productivity/iot/devices/footswitch/footswitch-dropdown.png similarity index 100% rename from content/applications/productivity/iot/devices/footswitch/footswitch_01.png rename to content/applications/productivity/iot/devices/footswitch/footswitch-dropdown.png diff --git a/content/applications/productivity/iot/devices/footswitch/footswitch-example.png b/content/applications/productivity/iot/devices/footswitch/footswitch-example.png new file mode 100644 index 000000000..45fe58a92 Binary files /dev/null and b/content/applications/productivity/iot/devices/footswitch/footswitch-example.png differ diff --git a/content/applications/productivity/iot/devices/footswitch/footswitch_03.png b/content/applications/productivity/iot/devices/footswitch/footswitch_03.png deleted file mode 100644 index eefd87242..000000000 Binary files a/content/applications/productivity/iot/devices/footswitch/footswitch_03.png and /dev/null differ diff --git a/content/applications/productivity/iot/devices/measurement_tool.rst b/content/applications/productivity/iot/devices/measurement_tool.rst index 012e59b40..4185c1df4 100644 --- a/content/applications/productivity/iot/devices/measurement_tool.rst +++ b/content/applications/productivity/iot/devices/measurement_tool.rst @@ -1,52 +1,90 @@ ========================== -Connect a Measurement Tool +Connect a measurement tool ========================== -With Odoo’s *IoT Box*, it is possible to connect measurement tools to -your database. Find the list of supported devices here: `Supported -devices `__,. +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 +`_. -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` diff --git a/content/applications/productivity/iot/devices/measurement_tool/device-dropdown.png b/content/applications/productivity/iot/devices/measurement_tool/device-dropdown.png new file mode 100644 index 000000000..fb00d9497 Binary files /dev/null and b/content/applications/productivity/iot/devices/measurement_tool/device-dropdown.png differ diff --git a/content/applications/productivity/iot/devices/measurement_tool/measurement-control-point.png b/content/applications/productivity/iot/devices/measurement_tool/measurement-control-point.png new file mode 100644 index 000000000..fa9bfb832 Binary files /dev/null and b/content/applications/productivity/iot/devices/measurement_tool/measurement-control-point.png differ diff --git a/content/applications/productivity/iot/devices/measurement_tool/measurement-tool.jpeg b/content/applications/productivity/iot/devices/measurement_tool/measurement-tool.jpeg new file mode 100644 index 000000000..b7a4f2a1f Binary files /dev/null and b/content/applications/productivity/iot/devices/measurement_tool/measurement-tool.jpeg differ diff --git a/content/applications/productivity/iot/devices/measurement_tool/measurement_tool_01.png b/content/applications/productivity/iot/devices/measurement_tool/measurement_tool_01.png deleted file mode 100644 index 4eb11afac..000000000 Binary files a/content/applications/productivity/iot/devices/measurement_tool/measurement_tool_01.png and /dev/null differ diff --git a/content/applications/productivity/iot/devices/measurement_tool/measurement_tool_03.png b/content/applications/productivity/iot/devices/measurement_tool/measurement_tool_03.png deleted file mode 100644 index c6be05a59..000000000 Binary files a/content/applications/productivity/iot/devices/measurement_tool/measurement_tool_03.png and /dev/null differ diff --git a/content/applications/productivity/iot/devices/measurement_tool/measurement_tool_04.png b/content/applications/productivity/iot/devices/measurement_tool/measurement_tool_04.png deleted file mode 100644 index 83b8c3423..000000000 Binary files a/content/applications/productivity/iot/devices/measurement_tool/measurement_tool_04.png and /dev/null differ diff --git a/content/applications/productivity/iot/devices/measurement_tool/measurement_tool_05.png b/content/applications/productivity/iot/devices/measurement_tool/measurement_tool_05.png deleted file mode 100644 index b07173a0a..000000000 Binary files a/content/applications/productivity/iot/devices/measurement_tool/measurement_tool_05.png and /dev/null differ diff --git a/content/applications/productivity/iot/devices/printer.rst b/content/applications/productivity/iot/devices/printer.rst index d9b05d957..635d28d9c 100644 --- a/content/applications/productivity/iot/devices/printer.rst +++ b/content/applications/productivity/iot/devices/printer.rst @@ -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 `__ 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 +`__ 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 + `. 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. diff --git a/content/applications/productivity/iot/devices/printer/printer_04.png b/content/applications/productivity/iot/devices/printer/print-labels-button.png similarity index 100% rename from content/applications/productivity/iot/devices/printer/printer_04.png rename to content/applications/productivity/iot/devices/printer/print-labels-button.png diff --git a/content/applications/productivity/iot/devices/printer/printer-controlpoint.png b/content/applications/productivity/iot/devices/printer/printer-controlpoint.png new file mode 100644 index 000000000..49dacae10 Binary files /dev/null and b/content/applications/productivity/iot/devices/printer/printer-controlpoint.png differ diff --git a/content/applications/productivity/iot/devices/printer/printer_01.png b/content/applications/productivity/iot/devices/printer/printer-detected.png similarity index 100% rename from content/applications/productivity/iot/devices/printer/printer_01.png rename to content/applications/productivity/iot/devices/printer/printer-detected.png diff --git a/content/applications/productivity/iot/devices/printer/printer-prompt.png b/content/applications/productivity/iot/devices/printer/printer-prompt.png new file mode 100644 index 000000000..80ba6bc1d Binary files /dev/null and b/content/applications/productivity/iot/devices/printer/printer-prompt.png differ diff --git a/content/applications/productivity/iot/devices/printer/printer_03.png b/content/applications/productivity/iot/devices/printer/printer_03.png deleted file mode 100644 index 17c246655..000000000 Binary files a/content/applications/productivity/iot/devices/printer/printer_03.png and /dev/null differ diff --git a/content/applications/productivity/iot/devices/printer/printer_05.png b/content/applications/productivity/iot/devices/printer/printer_05.png deleted file mode 100644 index 4cc3b85e0..000000000 Binary files a/content/applications/productivity/iot/devices/printer/printer_05.png and /dev/null differ diff --git a/content/applications/productivity/iot/devices/printer/printer_06.png b/content/applications/productivity/iot/devices/printer/printer_06.png deleted file mode 100644 index b36fb302a..000000000 Binary files a/content/applications/productivity/iot/devices/printer/printer_06.png and /dev/null differ diff --git a/content/applications/productivity/iot/devices/printer/printer_07.png b/content/applications/productivity/iot/devices/printer/printer_07.png deleted file mode 100644 index 2cb8f839f..000000000 Binary files a/content/applications/productivity/iot/devices/printer/printer_07.png and /dev/null differ diff --git a/content/applications/productivity/iot/devices/printer/printer_08.png b/content/applications/productivity/iot/devices/printer/printer_08.png deleted file mode 100644 index e4561a647..000000000 Binary files a/content/applications/productivity/iot/devices/printer/printer_08.png and /dev/null differ diff --git a/content/applications/productivity/iot/devices/printer/printer_09.png b/content/applications/productivity/iot/devices/printer/printer_09.png deleted file mode 100644 index c7ea2e431..000000000 Binary files a/content/applications/productivity/iot/devices/printer/printer_09.png and /dev/null differ diff --git a/content/applications/productivity/iot/devices/printer/printer_10.png b/content/applications/productivity/iot/devices/printer/printer_10.png deleted file mode 100644 index 0ad40d680..000000000 Binary files a/content/applications/productivity/iot/devices/printer/printer_10.png and /dev/null differ diff --git a/content/applications/productivity/iot/devices/printer/printer_11.png b/content/applications/productivity/iot/devices/printer/printer_11.png deleted file mode 100644 index 36ef5f815..000000000 Binary files a/content/applications/productivity/iot/devices/printer/printer_11.png and /dev/null differ diff --git a/content/applications/productivity/iot/devices/printer/printer_12.png b/content/applications/productivity/iot/devices/printer/printer_12.png deleted file mode 100644 index 840d5f788..000000000 Binary files a/content/applications/productivity/iot/devices/printer/printer_12.png and /dev/null differ diff --git a/content/applications/productivity/iot/devices/printer/printers-listed.png b/content/applications/productivity/iot/devices/printer/printers-listed.png new file mode 100644 index 000000000..4c6353b69 Binary files /dev/null and b/content/applications/productivity/iot/devices/printer/printers-listed.png differ diff --git a/content/applications/productivity/iot/devices/scale.rst b/content/applications/productivity/iot/devices/scale.rst index 6ecf1ae7b..3e312d85e 100644 --- a/content/applications/productivity/iot/devices/scale.rst +++ b/content/applications/productivity/iot/devices/scale.rst @@ -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 `_, 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 `_, 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 diff --git a/content/applications/productivity/iot/devices/scale/driver-list.png b/content/applications/productivity/iot/devices/scale/driver-list.png index d87a4cca9..27c6ba1a6 100644 Binary files a/content/applications/productivity/iot/devices/scale/driver-list.png and b/content/applications/productivity/iot/devices/scale/driver-list.png differ diff --git a/content/applications/productivity/iot/devices/scale/electronic-scale-feature.png b/content/applications/productivity/iot/devices/scale/electronic-scale-feature.png index 6bd38692b..4dae1e608 100644 Binary files a/content/applications/productivity/iot/devices/scale/electronic-scale-feature.png and b/content/applications/productivity/iot/devices/scale/electronic-scale-feature.png differ diff --git a/content/applications/productivity/iot/devices/screen.rst b/content/applications/productivity/iot/devices/screen.rst index 189d533fa..8d8cd707c 100644 --- a/content/applications/productivity/iot/devices/screen.rst +++ b/content/applications/productivity/iot/devices/screen.rst @@ -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 `). .. 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 `. .. 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. diff --git a/content/applications/productivity/iot/devices/screen/screen-pos-client-display-no-order.png b/content/applications/productivity/iot/devices/screen/screen-pos-client-display-no-order.png index 633c09ff7..f686317a9 100644 Binary files a/content/applications/productivity/iot/devices/screen/screen-pos-client-display-no-order.png and b/content/applications/productivity/iot/devices/screen/screen-pos-client-display-no-order.png differ diff --git a/content/applications/productivity/iot/devices/screen/screen-pos-client-display.png b/content/applications/productivity/iot/devices/screen/screen-pos-client-display.png index 131215be2..3be1efd31 100644 Binary files a/content/applications/productivity/iot/devices/screen/screen-pos-client-display.png and b/content/applications/productivity/iot/devices/screen/screen-pos-client-display.png differ diff --git a/content/applications/productivity/iot/devices/screen/screen-pos-screen-config.png b/content/applications/productivity/iot/devices/screen/screen-pos-screen-config.png index 9fabaa237..27613f623 100644 Binary files a/content/applications/productivity/iot/devices/screen/screen-pos-screen-config.png and b/content/applications/productivity/iot/devices/screen/screen-pos-screen-config.png differ