[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#8063 Signed-off-by: Jonathan Castillo (jcs) <jcs@odoo.com>
@@ -0,0 +1,16 @@
|
||||
:nosearch:
|
||||
|
||||
=============
|
||||
Configuration
|
||||
=============
|
||||
|
||||
.. toctree::
|
||||
:titlesonly:
|
||||
:glob:
|
||||
|
||||
config/connect
|
||||
config/pos
|
||||
config/https_certificate_iot
|
||||
config/flash_sdcard
|
||||
config/troubleshooting
|
||||
config/windows_iot
|
||||
@@ -0,0 +1,181 @@
|
||||
==========================
|
||||
Connect an IoT box to Odoo
|
||||
==========================
|
||||
|
||||
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.
|
||||
|
||||
.. seealso::
|
||||
`IoT Box FAQ <https://www.odoo.com/app/iot-faq>`_
|
||||
|
||||
Begin the :abbr:`IoT (Internet of Things)` configuration process by :ref:`installing the IoT app
|
||||
<general/install>` 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.
|
||||
|
||||
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/connect-iot.png
|
||||
:align: center
|
||||
:alt: Connecting an IoT box to the Odoo database.
|
||||
|
||||
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 <iot_connect/ethernet>` or
|
||||
via :ref:`WiFi <iot_connect/wifi>`.
|
||||
|
||||
.. image:: connect/connect-iot-box.png
|
||||
:align: center
|
||||
:alt: Connection steps for a wired connection or WiFi 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 <flash_sdcard>` with the
|
||||
most up-to-date disk image.
|
||||
|
||||
.. _iot_connect/ethernet:
|
||||
|
||||
Ethernet connection
|
||||
===================
|
||||
|
||||
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).
|
||||
|
||||
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.
|
||||
|
||||
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.
|
||||
|
||||
.. 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::
|
||||
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`.
|
||||
|
||||
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
|
||||
===============
|
||||
|
||||
The following is the process to connect the :abbr:`IoT (Internet of Things)` box via a WiFi
|
||||
connection to the Odoo database.
|
||||
|
||||
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.).
|
||||
|
||||
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.
|
||||
|
||||
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/connect-iot-wifi.png
|
||||
:align: center
|
||||
:alt: WiFi networks available on the computer.
|
||||
|
||||
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 <iot_connect/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
|
||||
==============
|
||||
|
||||
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.
|
||||
|
After Width: | Height: | Size: 61 KiB |
|
After Width: | Height: | Size: 48 KiB |
|
After Width: | Height: | Size: 53 KiB |
|
After Width: | Height: | Size: 8.6 KiB |
|
After Width: | Height: | Size: 3.8 KiB |
|
After Width: | Height: | Size: 21 KiB |
|
After Width: | Height: | Size: 12 KiB |
|
After Width: | Height: | Size: 11 KiB |
|
After Width: | Height: | Size: 33 KiB |
@@ -0,0 +1,68 @@
|
||||
====================
|
||||
Flashing the SD card
|
||||
====================
|
||||
|
||||
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 home page
|
||||
==================================
|
||||
|
||||
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 :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-upgrade.png
|
||||
:align: center
|
||||
:alt: IoT box software upgrade in the IoT Box Home Page.
|
||||
|
||||
.. _flash_sdcard/etcher:
|
||||
|
||||
Upgrade with Etcher Software
|
||||
============================
|
||||
|
||||
.. note::
|
||||
A computer with a micro SD card reader/adapter is required in order to re-flash the micro SD
|
||||
card.
|
||||
|
||||
Navigate to Balena's website and download `Etcher <https://www.balena.io/>`_. It's a free and
|
||||
open-source utility used for burning image files onto drives. Click to `download
|
||||
<https://www.balena.io/etcher#download-etcher>`_. Install and launch the program on the computer.
|
||||
|
||||
Then download the version-specific :abbr:`IoT (Internet of Things)` image from `nightly
|
||||
<http://nightly.odoo.com/master/iotbox/>`_.
|
||||
|
||||
The following are image versions on the `nightly <http://nightly.odoo.com/master/iotbox/>`_ 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 <https://www.raspberrypi.com/software/>`_.
|
||||
|
After Width: | Height: | Size: 24 KiB |
|
After Width: | Height: | Size: 115 KiB |
@@ -0,0 +1,258 @@
|
||||
.. _iot/https_certificate_iot:
|
||||
|
||||
=======================
|
||||
HTTPS certificate (IoT)
|
||||
=======================
|
||||
|
||||
What is HTTPS?
|
||||
==============
|
||||
|
||||
*Hypertext Transfer Protocol Secure* (HTTPS) is the secure version of *Hypertext Transfer Protocol*
|
||||
(HTTP), which is the primary protocol used to send data back and forth between a web browser and a
|
||||
website. :abbr:`HTTPS (Hypertext Transfer Protocol Secure)` is encrypted in order to increase the
|
||||
security of data transfer.
|
||||
|
||||
:abbr:`HTTPS (Hypertext Transfer Protocol Secure)` uses an encryption protocol to encrypt
|
||||
communications. The protocol is called *Transport Layer Security* (TLS), although formerly it was
|
||||
known as *Secure Sockets Layer* (SSL).
|
||||
|
||||
:abbr:`HTTPS (Hypertext Transfer Protocol Secure)` occurs based upon the transmission of :abbr:`TLS
|
||||
(Transport Layer Security)`/:abbr:`SSL (Secure Sockets Layer)` certificates, which verify that a
|
||||
particular provider is who they say they are.
|
||||
|
||||
.. note::
|
||||
In this documentation and throughout Odoo the term "HTTPS certificate" will be used to define the
|
||||
fact that the :abbr:`SSL (Secure Sockets Layer)` certificate is valid and allows a :abbr:`HTTPS
|
||||
(Hypertext Transfer Protocol Secure)` connection.
|
||||
|
||||
Why is it needed?
|
||||
-----------------
|
||||
|
||||
In order to communicate with certain network devices (in particular for payment terminals), the
|
||||
usage of :abbr:`HTTPS (Hypertext Transfer Protocol Secure)` is mandatory. If the :abbr:`HTTPS
|
||||
(Hypertext Transfer Protocol Secure)` certificate isn't valid, some devices won't be able to
|
||||
interact with the :abbr:`IoT (Internet of Things)` Box.
|
||||
|
||||
How to obtain a Hypertext Transfer Protocol Secure (HTTPS) certificate
|
||||
======================================================================
|
||||
|
||||
The generation of the :abbr:`HTTPS (Hypertext Transfer Protocol Secure)` certificate is automatic.
|
||||
|
||||
The :abbr:`IoT (Internet of Things)` Box will send a specific request to `<https://www.odoo.com>`_
|
||||
which will send back the :abbr:`HTTPS (Hypertext Transfer Protocol Secure)` certificate if the
|
||||
:abbr:`IoT (Internet of Things)` box and database are eligible.
|
||||
|
||||
.. _iot/iot-eligibility:
|
||||
|
||||
Internet of Things (IoT) eligibility
|
||||
------------------------------------
|
||||
|
||||
#. The database should be a **production** instance. The database instance should not be a copy, a
|
||||
duplicate, a staging, or a development environment.
|
||||
#. The Odoo subscription must:
|
||||
|
||||
- Have an :guilabel:`IoT Box Subscription` line.
|
||||
- :guilabel:`Status` must be :guilabel:`In Progress`.
|
||||
|
||||
If the subscription is linked to a `<https://www.odoo.com>`_ portal user check the information
|
||||
on the portal subscription page.
|
||||
|
||||
.. figure:: https_certificate_iot/sub-example-in-progress.png
|
||||
:align: center
|
||||
:alt: Odoo.com portal subscriptions filtered by "in progress".
|
||||
|
||||
In this case, both subscriptions are considered "in progress" as the :guilabel:`Filter By\:
|
||||
In Progress` was used.
|
||||
|
||||
.. note::
|
||||
If the subscription is in question, contact the database's Account Manager or Partner
|
||||
regarding the matter.
|
||||
|
||||
Troubleshooting Hypertext Transfer Protocol Secure (HTTPS) certificate errors
|
||||
=============================================================================
|
||||
|
||||
If anything goes wrong during the process of the "HTTPS certificate" generation or reception, a
|
||||
specific error will code be given on the :abbr:`IoT (Internet of Things)` box home page.
|
||||
|
||||
.. tip::
|
||||
Accessing the :abbr:`IoT (Internet of Things)` box homepage will check for the presence of the
|
||||
"HTTPS certificate" and will attempt its generation if it is missing. As such, if there is an
|
||||
error on the :abbr:`IoT (Internet of Things)` box home page, refresh the :abbr:`IoT (Internet of
|
||||
Things)` home page to see if the error disappears.
|
||||
|
||||
`ERR_IOT_HTTPS_CHECK_NO_SERVER`
|
||||
-------------------------------
|
||||
|
||||
Reason:
|
||||
The configuration regarding the server is missing. In other words, the Odoo instance is not
|
||||
connected with the IoT box.
|
||||
|
||||
Solution:
|
||||
Ensure that the server is configured.
|
||||
|
||||
.. seealso::
|
||||
:doc:`/applications/general/iot/config/connect`
|
||||
|
||||
`ERR_IOT_HTTPS_CHECK_CERT_READ_EXCEPTION`
|
||||
-----------------------------------------
|
||||
|
||||
Reason:
|
||||
An unhandled error happened when trying to read the existing :abbr:`HTTPS (Hypertext Transfer
|
||||
Protocol Secure)` certificate.
|
||||
|
||||
Solution:
|
||||
Ensure that the :abbr:`HTTPS (Hypertext Transfer Protocol Secure)` certificate file is readable.
|
||||
|
||||
`ERR_IOT_HTTPS_LOAD_NO_CREDENTIAL`
|
||||
----------------------------------
|
||||
|
||||
Reason:
|
||||
The contract and/or database :abbr:`UUID (Universal Unique Identifier)` is missing.
|
||||
|
||||
Solution:
|
||||
Ensure that both values are configured as intended. To modify them, go to the :abbr:`IoT
|
||||
(Internet of Things)` box home page, and navigate to :guilabel:`Credential`.
|
||||
|
||||
`ERR_IOT_HTTPS_LOAD_REQUEST_EXCEPTION`
|
||||
--------------------------------------
|
||||
|
||||
Reason:
|
||||
An unexpected error happened when the :abbr:`IoT (Internet of Things)` box tried to reach
|
||||
`<https://www.odoo.com>`_. The causes are likely due to the network
|
||||
infrastructure/configuration:
|
||||
|
||||
- The :abbr:`IoT (Internet of Things)` box does not have access to internet.
|
||||
- The network does not allow the :abbr:`IoT (Internet of Things)` box to communicate with
|
||||
`<https://www.odoo.com>`_. This may be due to network devices preventing the communication
|
||||
(firewalls, etc.) or the network configuration (:abbr:`VPN (Virtual Private Network)`,
|
||||
etc.).
|
||||
|
||||
.. note::
|
||||
More information regarding the error that occurred can be found in the full request
|
||||
exception details, which are in the :abbr:`IoT (Internet of Things)` box logs.
|
||||
|
||||
Solution:
|
||||
.. warning::
|
||||
Consult with your system or network administrator should this issue arise. This error code
|
||||
depends on the network infrastructure and goes beyond Odoo support's service scope.
|
||||
|
||||
`ERR_IOT_HTTPS_LOAD_REQUEST_STATUS`
|
||||
-----------------------------------
|
||||
|
||||
Reason:
|
||||
The IoT-box was able to reach `<https://www.odoo.com>`_ but received an unusual
|
||||
`HTTP response (status codes)
|
||||
<https://developer.mozilla.org/en-US/docs/Web/HTTP/Status>`_.
|
||||
|
||||
This error code will also give the HTTP response status codes. For example, if the error reads
|
||||
`ERR_IOT_HTTPS_LOAD_REQUEST_STATUS 404` it means that the page returned a 404 error, which is
|
||||
the "Page Not Found" code.
|
||||
|
||||
Solution:
|
||||
Check if `<https://www.odoo.com>`_ is down using a web browser, as it's possible that it is down
|
||||
due to maintenance.
|
||||
|
||||
- If `<https://www.odoo.com>`_ is down due to maintenance, unfortunately there is nothing that
|
||||
can be done but instead wait for it to recover.
|
||||
- If `<https://www.odoo.com>`_ is not down due to maintenance, open a `support ticket
|
||||
<https://www.odoo.com/help>`_ on the matter. Ensure that the 3 digits status code next to the
|
||||
code error is included in the support ticket.
|
||||
|
||||
`ERR_IOT_HTTPS_LOAD_REQUEST_NO_RESULT`
|
||||
--------------------------------------
|
||||
|
||||
Reason:
|
||||
The :abbr:`IoT (Internet of Things)` box was able to reach `<https://www.odoo.com>`_ but it
|
||||
refused to deliver the :abbr:`HTTPS (Hypertext Transfer Protocol Secure)` certificate.
|
||||
|
||||
Solution:
|
||||
Ensure that the :abbr:`IoT (Internet of Things)` box and database are eligible for a
|
||||
certificate: :ref:`Internet of Things (IoT) eligibility <iot/iot-eligibility>`.
|
||||
|
||||
How to ensure that the HTTPS certificate is correct
|
||||
===================================================
|
||||
|
||||
If the certificate has been applied successfully, a new :abbr:`HTTPS (Hypertext Transfer Protocol
|
||||
Secure)` :abbr:`URL (Uniform Resource Locator)` for the :abbr:`IoT (Internet of Things)` box ending
|
||||
with `.odoo-iot.com` will appear on the Odoo database, inside of the :menuselection:`IoT`
|
||||
application on that specific device's form.
|
||||
|
||||
.. image:: https_certificate_iot/odoo-new-domain.png
|
||||
:align: center
|
||||
:alt: Odoo IoT app IoT box with .odoo-iot.com domain.
|
||||
|
||||
When navigating to the :abbr:`URL (Uniform Resource Locator)` in a browser a secured :abbr:`HTTPS
|
||||
(Hypertext Transfer Protocol Secure)` connection will be established.
|
||||
|
||||
.. figure:: https_certificate_iot/secured-connection.png
|
||||
:align: center
|
||||
:alt: Example of valid SSL certificate details on the browser.
|
||||
|
||||
Padlock in Chrome on Windows 10 attesting the fact that the connection is secured in :abbr:`HTTPS
|
||||
(Hypertext Transfer Protocol Secure)`.
|
||||
|
||||
The IoT-box homepage will now display an `OK` status next to `HTTPS certificate`. The
|
||||
drop-down menu icon, when clicked, will reveal information regarding the certificate.
|
||||
|
||||
.. image:: https_certificate_iot/status-ok.png
|
||||
:align: center
|
||||
:alt: IoT box homepage with HTTPS certificate OK status.
|
||||
|
||||
Domain Name System (DNS) issue
|
||||
==============================
|
||||
|
||||
If the :abbr:`IoT (Internet of Things)` box can be accessed from its :abbr:`IP (Intrernet Protocol)`
|
||||
address but not the Odoo assigned domain: `.odoo-iot.com`; then the :abbr:`IoT (Internet of Things)`
|
||||
box is likely running into a :abbr:`DNS (Domain Name System)` issue. On some browsers, it will give
|
||||
an error code mentioning :abbr:`DNS (Domain Name System)` (like `DNS_PROBE_FINISHED_NXDOMAIN`).
|
||||
|
||||
These :abbr:`DNS (Domain Name System)` issues may appear as the following in different browsers:
|
||||
|
||||
.. tabs::
|
||||
|
||||
.. tab:: Chrome
|
||||
|
||||
.. figure:: https_certificate_iot/dns-chrome.png
|
||||
:align: center
|
||||
:alt: DNS issue on Chrome browser on Windows 10.
|
||||
|
||||
DNS issue on Chrome browser on Windows 10.
|
||||
|
||||
|
||||
.. tab:: Firefox
|
||||
|
||||
.. figure:: https_certificate_iot/dns-firefox.png
|
||||
:align: center
|
||||
:alt: DNS issue on Firefox browser on Windows 10.
|
||||
|
||||
DNS issue on Firefox browser on Windows 10.
|
||||
|
||||
.. tab:: Edge
|
||||
|
||||
.. figure:: https_certificate_iot/dns-edge.png
|
||||
:align: center
|
||||
:alt: DNS issue on Edge browser on Windows 10.
|
||||
|
||||
DNS issue on Edge browser on Windows 10.
|
||||
|
||||
|
||||
Domain Name System (DNS) issue solution
|
||||
---------------------------------------
|
||||
|
||||
#. Should the router allow the :abbr:`DNS (Domain Name System)` to be manually changed, change the
|
||||
DNS to use `Google DNS <https://developers.google.com/speed/public-dns>`_.
|
||||
#. If your router doesn't allow for this, then a change will need to be made on the :abbr:`DNS
|
||||
(Domain Name System)` settings of each of the devices using `Google DNS
|
||||
<https://developers.google.com/speed/public-dns>`_. This will need to occur on **every** device
|
||||
that plans to interact with the :abbr:`IoT (Internet of Things)` box (e.g. computer, tablet or
|
||||
phone). The individual device configuration processes can be found on the website of the
|
||||
device's manufacturer.
|
||||
|
||||
.. note::
|
||||
Other :abbr:`IoT (Internet of Things)` devices such as payment terminals likely won't need
|
||||
their :abbr:`DNS (Domain Name System)` settings changed as they are already configured with
|
||||
custom :abbr:`DNS (Domain Name System)`.
|
||||
|
||||
.. warning::
|
||||
Consult with your system or network administrator should this issue arise. This error code
|
||||
depends on the network infrastructure, and it goes beyond Odoo support's service scope.
|
||||
|
After Width: | Height: | Size: 19 KiB |
|
After Width: | Height: | Size: 20 KiB |
|
After Width: | Height: | Size: 26 KiB |
|
After Width: | Height: | Size: 27 KiB |
|
After Width: | Height: | Size: 6.2 KiB |
|
After Width: | Height: | Size: 34 KiB |
|
After Width: | Height: | Size: 16 KiB |
@@ -0,0 +1,67 @@
|
||||
=========================
|
||||
Use an IoT box with a PoS
|
||||
=========================
|
||||
|
||||
Prerequisites
|
||||
=============
|
||||
|
||||
Before starting, make sure the following equipment is available:
|
||||
|
||||
- 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 <https://www.odoo.com/page/point-of-sale-hardware>`_.
|
||||
|
||||
Setup
|
||||
=====
|
||||
|
||||
.. figure:: pos/pos-connections.png
|
||||
|
||||
A suggested configuration for a point of sale system.
|
||||
|
||||
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 <connect>`.
|
||||
|
||||
Then, connect the peripheral devices to the :abbr:`IoT (Internet of Things)` box.
|
||||
|
||||
.. list-table::
|
||||
:header-rows: 1
|
||||
:stub-columns: 1
|
||||
|
||||
* - 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:`../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:`../devices/screen`.
|
||||
* - Payment terminal
|
||||
- The connection process depends on the terminal. Refer to the :doc:`payment terminals
|
||||
documentation </applications/sales/point_of_sale/payment_methods>`.
|
||||
|
||||
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.
|
||||
|
||||
.. image:: pos/iot-connected-devices.png
|
||||
:align: center
|
||||
:alt: Configuring the connected devices in the POS application.
|
||||
|
||||
Once set up is done, a new :abbr:`PoS (Point of Sale)` session can be launched.
|
||||
|
After Width: | Height: | Size: 7.5 KiB |
|
After Width: | Height: | Size: 26 KiB |
@@ -0,0 +1,485 @@
|
||||
===============
|
||||
Troubleshooting
|
||||
===============
|
||||
|
||||
IoT box connection
|
||||
==================
|
||||
|
||||
Unable to locate the pairing code to connect the IoT box
|
||||
--------------------------------------------------------
|
||||
|
||||
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 does not show under the following circumstances:
|
||||
|
||||
- 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 is 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 <flash_sdcard>`).
|
||||
|
||||
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.
|
||||
|
||||
IoT box is connected but it is not showing in the database
|
||||
----------------------------------------------------------
|
||||
|
||||
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 does not use a multi-database environment.
|
||||
|
||||
To access the database from the :abbr:`IoT (Internet of Things)` box, open a browser and type in the
|
||||
database address.
|
||||
|
||||
The IoT box is connected to the Odoo database, but cannot be reached
|
||||
--------------------------------------------------------------------
|
||||
|
||||
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.
|
||||
|
||||
The HTTPS certificate does not generate
|
||||
---------------------------------------
|
||||
|
||||
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) <https_certificate_iot>`
|
||||
|
||||
Printer
|
||||
=======
|
||||
|
||||
The printer is not detected
|
||||
---------------------------
|
||||
|
||||
If a printer does not appear 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/printer-status.png
|
||||
:align: center
|
||||
:alt: The IoT box Home Page landing page.
|
||||
|
||||
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 is likely not connected properly.
|
||||
|
||||
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.
|
||||
|
||||
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` drop-down menu, click on
|
||||
:guilabel:`Modify Printer`. Follow the steps and select the *make* and *model* corresponding to the
|
||||
printer.
|
||||
|
||||
.. 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 configuration special case
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Most Epson printers support printing receipts in Odoo :abbr:`POS (Point of Sale)` using the `GS v 0`
|
||||
command. However, the following Epson printer models do not support this command:
|
||||
|
||||
- TM-U220
|
||||
- TM-U230
|
||||
- TM-P60
|
||||
- TMP-P60II
|
||||
|
||||
Bypass this issue by configuring the printer to use the `ESC *` command instead.
|
||||
|
||||
Process to force ESC * command
|
||||
******************************
|
||||
|
||||
Epson printer compatibility
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
The first step is to check whether the printer is incompatible with `GS v 0` command.
|
||||
|
||||
.. seealso::
|
||||
|
||||
- `Epson GS v 0 documentation <https://reference.epson-biz.com/modules/ref_escpos/index.php?
|
||||
content_id=94>`_ for `GS v 0` compatible printers.
|
||||
- `Epson ESC * documentation <https://reference.epson-biz.com/modules/ref_escpos/index.php
|
||||
?content_id=88>`_ for `ESC *` compatible printers.
|
||||
|
||||
If the printer is not compatible with the `ESC *` command then the following process is not
|
||||
possible. Should the printer be compatible to use the `ESC *` command to print, follow this process
|
||||
to configure the printer with the :abbr:`IoT (Internet of Things)` box.
|
||||
|
||||
IoT box configuration for ESC *
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
To configure the :abbr:`IoT (Internet of Things)` box to use the `ESC *` command to print, go to the
|
||||
:abbr:`IoT (Internet of Things)` box homepage by navigating to :menuselection:`IoT app --> IoT
|
||||
Boxes`. Then click on the :guilabel:`IP address` and this will direct to the :abbr:`IoT (Internet of
|
||||
Things)` box homepage.
|
||||
|
||||
**Choosing the printer**
|
||||
|
||||
Now click on the :guilabel:`Printers server` button. This will redirect the browser to the *CUPS*
|
||||
page. Next, go to :menuselection:`Administration --> Printers --> Add Printer`, choose the printer
|
||||
that should be modified, and then click :guilabel:`Continue`.
|
||||
|
||||
.. tip::
|
||||
If the name of the printer is still uncertain, take the following steps:
|
||||
|
||||
#. Take note of the listed printers on the *CUPS* page.
|
||||
#. Turn the printer off and refresh the page.
|
||||
#. Now compare the difference with the first list to see which printer disappeared.
|
||||
#. Turn the printer back on and refresh the page again.
|
||||
#. Double-check the list again to see if the printer re-appears.
|
||||
#. The printer that disappeared and reappears again on the listed printers is the name of the
|
||||
printer in question.
|
||||
|
||||
.. note::
|
||||
This can be :guilabel:`Unknown` under :guilabel:`Local printers`.
|
||||
|
||||
**CUPS naming convention**
|
||||
|
||||
`CUPS` will prompt the administrator for three pieces of information: the :guilabel:`Name`,
|
||||
:guilabel:`Description` and the :guilabel:`Location`. The last two pieces of information do not need
|
||||
to be specific, however, the :guilabel:`Name` should follow a particular convention to work with the
|
||||
`ESC *` command.
|
||||
|
||||
The :guilabel:`Name` should match this convention:
|
||||
`<printer_name>__IMC_<param_1>_<param_2>_..._<param_n>__`
|
||||
|
||||
A breakdown of the naming convention:
|
||||
|
||||
- `printer_name`: This is the printer name. It can be any character as long as it does not contain
|
||||
`_`, `/`, `#`, or ` ` (space character).
|
||||
- `IMC`: This stands for *Image Mode Column* (the simplified name for `ESC *`).
|
||||
- `param_1`: This stands for the specific parameter:
|
||||
|
||||
- `SCALE<X>`: Scale of the picture (with the same aspect ratio). `X` should be an integer
|
||||
describing the scale percentage that should be used.
|
||||
|
||||
.. example::
|
||||
`100` is the original size, `50` is half the size, `200` is twice the size.
|
||||
|
||||
- `LDV`: *Low Density Vertical* (will be set to *High Density Vertical* if not specified).
|
||||
- `LDH`: *Low Density Horizontal* (will be set to *High Density Horizontal* if not specified).
|
||||
|
||||
.. note::
|
||||
*Density* parameters might need to be configured in a particular way depending on the printer
|
||||
model.
|
||||
|
||||
.. seealso::
|
||||
Visit `Epson's ESC * documentation
|
||||
<https://reference.epson-biz.com/modules/ref_escpos/index.php?content_id=88>`_ and click on the
|
||||
printer model printer in the table above to see if the printer should set these parameters.
|
||||
|
||||
.. example::
|
||||
The following are examples of proper and improper name formatting:
|
||||
|
||||
Proper name formatting:
|
||||
|
||||
- `EPSONTMm30II__IMC__`
|
||||
- `EPSON_TM_U220__IMC_LDV_LDH_SCALE80__`
|
||||
|
||||
Improper name formatting (this will not prevent printing, but the result might not have the
|
||||
expected printed output):
|
||||
|
||||
- `EPSON TMm 30II` -> The name cannot have spaces.
|
||||
- `EPSONTMm30II` -> The name itself is correct, but it will not use `ESC *`.
|
||||
- `EPSONTMm30II__IMC` -> This name is missing the end `__`.
|
||||
- `EPSONTMm30II__IMC_XDV__` -> The parameter `XDV` does not match any existing parameters.
|
||||
- `EPSONTMm30II__IMC_SCALE__` -> The parameter `SCALE` is missing the scale value.
|
||||
|
||||
**Finish adding a printer**
|
||||
|
||||
After setting the name of the printer with the appropriate naming convention, click
|
||||
:guilabel:`Continue`. Next, set the :guilabel:`Make` value to :guilabel:`Raw` and for the
|
||||
:guilabel:`Model` value, set this to :guilabel:`Raw Queue (en)`.
|
||||
|
||||
After completing these steps, click :guilabel:`Add Printer`. If everything was done correctly, the
|
||||
page should redirect to the *Banners* page.
|
||||
|
||||
At this point the printer should have been created, now the :abbr:`IoT (Internet of Things)` box
|
||||
just needs to detect it and then sync to Odoo's server (this could take a few minutes).
|
||||
|
||||
**Adding the printer to Odoo PoS**
|
||||
|
||||
Once the printer is visible on the Odoo database, do not forget to choose it in the :abbr:`PoS
|
||||
(Point of Sale)`configuration as the :abbr:`IoT (Internet of Things)` printer. Navigate to
|
||||
:menuselection:`Pos App --> Settings --> Connected Devices --> IoT Box --> Receipt Printer -->
|
||||
Save`.
|
||||
|
||||
.. note::
|
||||
If the printer was set up incorrectly (it is still printing random text or the printed receipt is
|
||||
too big or small), then it cannot be modified via the printer name with *CUPS*. Instead, the
|
||||
above process can be repeated to set up another printer from scratch to create one with modified
|
||||
parameters.
|
||||
|
||||
**Example setup of the Epson TM-U220B printer using ESC**
|
||||
|
||||
.. spoiler::
|
||||
Click this text to reveal the example
|
||||
|
||||
The following is an example of the troubleshooting process for a TM-U220B printer model using the
|
||||
`ESC *` command. The receipt pictured below is an example of a receipt that is printing correctly
|
||||
due to proper formatting (in theory):
|
||||
|
||||
.. image:: troubleshooting/receipt-example.png
|
||||
:align: center
|
||||
:alt: Properly formatted receipt picture from a demo database.
|
||||
|
||||
Trying to print this receipt right-away prior to the proper formatting will not work as the
|
||||
TM-U220B printer model does not support `GS v 0`. Instead random characters will print:
|
||||
|
||||
.. image:: troubleshooting/receipt-print-random-letters.png
|
||||
:align: center
|
||||
:alt: Printer paper with seemingly random characters.
|
||||
|
||||
To properly configure formatting for the Epson TM-U220B printer model take the following steps.
|
||||
|
||||
After consulting Epson's website for compatibility for both of the commands: `GS v 0
|
||||
<https://reference.epson-biz.com/modules/ref_escpos/index.php?content_id=94>`_ and `ESC *
|
||||
<https://reference.epson-biz.com/modules/ref_escpos/index.php?content_id=88>`_, it can be seen
|
||||
that indeed the TM-U220B is not compatible with `GS v 0`, but is compatible with `ESC *`.
|
||||
|
||||
.. image:: troubleshooting/epson-compatibility-compare.png
|
||||
:align: center
|
||||
:alt: Epson compatibility evaluation from Epson website.
|
||||
|
||||
When adding the printer, *CUPS* will ask which printer should be added:
|
||||
|
||||
.. image:: troubleshooting/add-printer.png
|
||||
:align: center
|
||||
:alt: Administration menu, add printer selection.
|
||||
|
||||
In this case, the printer is connected via :abbr:`USB (Universal Serial Bus)` so it won' be part
|
||||
of the :guilabel:`Discovered Network Printers`. Instead it is likely part of the
|
||||
:guilabel:`Unknown` selection under :guilabel:`Local Printers`. By unplugging the printer's
|
||||
:abbr:`USB (Universal Serial Bus)` cable from the :abbr:`IoT (Internet of Things)` box and
|
||||
refreshing the page, the :guilabel:`Unknown` printer disappears. By plugging it back in, the
|
||||
printer reappears, so it can be said that this is the printer in question.
|
||||
|
||||
For the naming convention, since it needs to print using the `ESC *` command, it is imperative to
|
||||
add `__IMC`. Reference the printer model on `Epson's ESC * site
|
||||
<https://reference.epson-biz.com/modules/ref_escpos/index.php?content_id=88>`_ to find out more
|
||||
about the *density* parameters.
|
||||
|
||||
.. image:: troubleshooting/epson-tm-u220-specification.png
|
||||
:align: center
|
||||
:alt: Epson TM-U220 specifications on manufacturer's website.
|
||||
|
||||
For this particular model, TM-U220, `m` should be equal to 0 or 1. While referencing the
|
||||
:guilabel:`Description` below the pink box in the above picture, the `m` values could be 0, 1, 32
|
||||
or 33. So in this printers case, the `m` value can NOT be 32 or 33 (otherwise there will be
|
||||
random characters printed).
|
||||
|
||||
The table includes the numeric values: 32 and 33, they both occur if the :guilabel:`Number of
|
||||
bits for vertical data` is set to 24. This means that is a *High Vertical Density*. In the case
|
||||
of configuring the Epson TM-U220, the *Low Vertical Density* will need to be forced, as this
|
||||
printer model does not support *High Vertical Density* for this command `ESC *`.
|
||||
|
||||
To add a *Low Vertical Density*, add the `LDV` parameter to the naming convention.
|
||||
|
||||
.. image:: troubleshooting/add-printer-filled.png
|
||||
:align: center
|
||||
:alt: Add a *Low Vertical Density* (the `LDV` parameter) to the naming convention.
|
||||
|
||||
Click :guilabel:`Continue` to proceed. Next, set the :guilabel:`Make` value to :guilabel:`Raw`
|
||||
and for the :guilabel:`Model` value, set this to :guilabel:`Raw Queue (en)`.
|
||||
|
||||
.. image:: troubleshooting/add-printer-add.png
|
||||
:align: center
|
||||
:alt: Epson TM-U220 specifications on manufacturers website.
|
||||
|
||||
However, when trying to print with the naming convention: `EpsonTMU220B__IMC_LDV__`, it prints
|
||||
the receipt, but it is too big and outside the margin. To resolve this, add a new printer (and
|
||||
naming convention) with the `SCALE<X>` parameter to adapt to our receipt size.
|
||||
|
||||
Here are some examples:
|
||||
|
||||
.. list-table::
|
||||
:header-rows: 1
|
||||
|
||||
* - Printer Naming Convention
|
||||
- `EpsonTMU220B__IMC_LDV__`
|
||||
- `EpsonTMU220B__IMC_LDV_SCALE75__`
|
||||
- `EpsonTMU220B__IMC_LDV_LDH__`
|
||||
- `EpsonTMU220B__IMC_LDV_LDH_SCALE35__`
|
||||
* - .. image:: troubleshooting/receipt-example.png
|
||||
:align: center
|
||||
:alt: Receipt example format.
|
||||
- .. image:: troubleshooting/tm-u220-ldv.png
|
||||
:align: center
|
||||
:alt: Receipt format using naming convention: EpsonTMU220B__IMC_LDV__.
|
||||
- .. image:: troubleshooting/tm-u220-ldv-scale75.png
|
||||
:align: center
|
||||
:alt: Receipt format using naming convention: EpsonTMU220B__IMC_LDV_SCALE75__.
|
||||
- .. image:: troubleshooting/tm-u220-ldv-hdv.png
|
||||
:align: center
|
||||
:alt: Receipt format using naming convention: EpsonTMU220B__IMC_LDV_LDH__.
|
||||
- .. image:: troubleshooting/tm-u220-ldv-hdv-scale35.png
|
||||
:align: center
|
||||
:alt: Receipt format using naming convention: EpsonTMU220B__IMC_LDV_LDH_SCALE35__.
|
||||
|
||||
The Zebra printer does not print anything
|
||||
-----------------------------------------
|
||||
|
||||
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 <developer-mode>` and look for the corresponding
|
||||
template.
|
||||
|
||||
.. seealso::
|
||||
Check out Zebra's instructions on printing :abbr:`ZPL (Zebra Programming Language)` files `here
|
||||
<https://supportcommunity.zebra.com/s/article/Print-a-zpl-file-using-the-Generic-Text-Printer>`_.
|
||||
|
||||
Barcode scanner
|
||||
===============
|
||||
|
||||
The characters read by the barcode scanner do not match the barcode
|
||||
-------------------------------------------------------------------
|
||||
|
||||
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 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
|
||||
---------------------------------------------
|
||||
|
||||
.. 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.
|
||||
|
||||
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/barcode-scanner-settings.png
|
||||
:align: center
|
||||
:alt: Modifying the form view of the barcode scanner.
|
||||
|
||||
Barcode scanner processes barcode characters individually
|
||||
---------------------------------------------------------
|
||||
|
||||
When accessing the mobile version of Odoo from a mobile device, or tablet, paired with a barcode
|
||||
scanner, via the :abbr:`IoT (Internet of Things)` box, the scanner may process each barcode
|
||||
character as an individual scan. In this case, the *Keyboard Layout* option **must** be filled out
|
||||
with the appropriate language of the barcode scanner on the *Barcode Scanner* form page.
|
||||
|
||||
.. tip::
|
||||
Access the barcode scanner form page by navigating to :menuselection:`IoT App --> Devices -->
|
||||
Barcode Scanner`.
|
||||
|
||||
.. image:: troubleshooting/keyboard-layout.png
|
||||
:align: center
|
||||
:alt: Barcode scanner form page, with keyboard layout option highlighted.
|
||||
|
||||
The :guilabel:`Keyboard Layout` is language based, and the options available vary, depending on the
|
||||
device and the language of the database. For example: :guilabel:`English (UK)`, :guilabel:`English
|
||||
(US)`, etc.
|
||||
|
||||
Cash drawer
|
||||
===========
|
||||
|
||||
The cash drawer does not open
|
||||
-----------------------------
|
||||
|
||||
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`.
|
||||
|
||||
Scale
|
||||
=====
|
||||
|
||||
Scales play a crucial role in the checkout process, especially for products sold by weight, rather
|
||||
than fixed pricing.
|
||||
|
||||
Set up Ariva S scales
|
||||
---------------------
|
||||
|
||||
Odoo has determined that a specific setting in Ariva S series scales (manufactured by
|
||||
Mettler-Toledo, LLC.) needs modification, and a dedicated Mettler :abbr:`USB (Universal Serial
|
||||
Bus)`-to-proprietary RJ45 cable is required for the scale to function with Odoo's :abbr:`IoT
|
||||
(Internet of Things)` box.
|
||||
|
||||
To correctly configure the scale for recognition by the :abbr:`IoT (Internet of Things)` box, follow
|
||||
this setup process for the Ariva S series scales.
|
||||
|
||||
.. important::
|
||||
It is crucial to use the official Mettler :abbr:`USB (Universal Serial Bus)`-to-RJ45 cable during
|
||||
this process.
|
||||
|
||||
Cable
|
||||
~~~~~
|
||||
|
||||
The Mettler part number is 72256236 - :abbr:`USB (Universal Serial Bus)`-to-:abbr:`POS (Point of
|
||||
Sale)` cable. Contact Mettler, or a partner, to purchase an authentic cable. Note that **no other**
|
||||
cable outside of this Mettler cable works for this configuration. Using a serial-only cable attached
|
||||
to a serial-to-:abbr:`USB (Universal Serial Bus)` adapter is **not** effective.
|
||||
|
||||
.. image:: troubleshooting/cable-mettler.png
|
||||
:align: center
|
||||
:alt: Authentic Mettler USB to POS cable, part number 72256236.
|
||||
|
||||
Setup
|
||||
~~~~~
|
||||
|
||||
Refer to Mettler's Setup Guide for Ariva S series scales during the following configuration: `Ariva
|
||||
Checkout Scale User's Guide <https://www.mt.com/dam/RET_DOCS/Ariv.pdf>`_.
|
||||
|
||||
To begin, go to page 17 in the above manual for *Setup*. This guide lists potential settings for the
|
||||
Ariva S series scales.
|
||||
|
||||
Follow the instructions, along with the following process, to set the scale to setup mode. First,
|
||||
hold the **>T<** button for eight seconds, or until :guilabel:`CONF` appears.
|
||||
|
||||
Next, press **>T<** until :guilabel:`GRP 3` appears, then press **>0<** to confirm.
|
||||
|
||||
Under :guilabel:`3.1`, ensure the setting is set to :guilabel:`1` (USB Virtual COM ports). Press
|
||||
**>T<** to cycle through the options under group 3.1.
|
||||
|
||||
Once :guilabel:`3.1` is set to :guilabel:`1`, press **>0<** to confirm the selection. Continue to
|
||||
press **>0<** until :guilabel:`GRP 4` appears.
|
||||
|
||||
Now, press **>T<** until :guilabel:`EXIT` appears.
|
||||
|
||||
.. important::
|
||||
Do **not** make any other changes unless otherwise needed.
|
||||
|
||||
Once :guilabel:`EXIT` appears, press **>0<**. Following this, press **>0<** again to
|
||||
:guilabel:`SAVE`. Now the scale restarts.
|
||||
|
||||
Finally, restart the :abbr:`IoT (Internet of Things)` box to recognize the changes made on the
|
||||
scale's configuration. After restarting, the scale appears as `Toledo 8217`, as opposed to the
|
||||
previous display, where it appeared as `Adam Equipment Serial`.
|
||||
|
After Width: | Height: | Size: 22 KiB |
|
After Width: | Height: | Size: 18 KiB |
|
After Width: | Height: | Size: 23 KiB |
|
After Width: | Height: | Size: 15 KiB |
|
After Width: | Height: | Size: 79 KiB |
|
After Width: | Height: | Size: 73 KiB |
|
After Width: | Height: | Size: 50 KiB |
|
After Width: | Height: | Size: 7.8 KiB |
|
After Width: | Height: | Size: 35 KiB |
|
After Width: | Height: | Size: 54 KiB |
|
After Width: | Height: | Size: 47 KiB |
|
After Width: | Height: | Size: 432 KiB |
|
After Width: | Height: | Size: 546 KiB |
|
After Width: | Height: | Size: 897 KiB |
|
After Width: | Height: | Size: 707 KiB |
|
After Width: | Height: | Size: 857 KiB |
@@ -0,0 +1,312 @@
|
||||
========================
|
||||
Connect Windows IoT Odoo
|
||||
========================
|
||||
|
||||
A Virtual IoT box is a computer program that needs to be downloaded and installed on a Windows
|
||||
computer. This requires a Windows operating system with an Odoo 16 or later database.
|
||||
|
||||
The Windows virtual :abbr:`IoT (Internet of Things)` box works the same way as a physical :abbr:`IoT
|
||||
(Internet of Things)` box, with the ability to run most of the same devices. All :abbr:`POS (Point
|
||||
of Sale)` devices work with it, such as a scale or printer. Payment terminals will also work, but it
|
||||
should be noted that :abbr:`MRP (Material Requirement Planning)` devices are not compatible. *These
|
||||
include cameras or measurement tools.*
|
||||
|
||||
Pre-requisites
|
||||
==============
|
||||
|
||||
The following items will be needed to complete the Windows :abbr:`IoT (Internet of Things)`
|
||||
installation.
|
||||
|
||||
- Odoo 16 database or any version above.
|
||||
- :abbr:`IoT (Internet of Things)` compatible devices (except those mentioned above). Refer to:
|
||||
`Odoo's compatible IoT devices <https://www.odoo.com/app/iot-hardware>`_.
|
||||
- Device drivers for Windows.
|
||||
|
||||
.. note::
|
||||
Odoo recommends using an updated, recent version of Windows (Windows 10/11) as some older
|
||||
operating systems can cause the Windows virtual :abbr:`IoT (Internet of Things)` to not work.
|
||||
|
||||
- Windows computer (laptop, desktop, or server).
|
||||
- Odoo :abbr:`IoT (Internet of Things)` subscription. Refer to: :ref:`iot/iot-eligibility`.
|
||||
|
||||
Connect the Windows virtual IoT box to an Odoo database
|
||||
=======================================================
|
||||
|
||||
The Windows virtual IoT box is simple to setup in just a few easy steps. Follow this process when
|
||||
installing the Windows virtual IoT software for the first time.
|
||||
|
||||
Download and initial installation
|
||||
---------------------------------
|
||||
|
||||
To begin the installation, navigate to the Odoo 16 or higher installation package for Enterprise or
|
||||
Community - Windows edition at `Odoo's download page <https://odoo.com/download>`_. Next, install
|
||||
and setup the Odoo :file:`.exe` file. After the instructions screen, click :guilabel:`Next` to start
|
||||
the installation and agree to the :abbr:`TOS (Terms of Service)`.
|
||||
|
||||
During the next step of the installation, select :guilabel:`Odoo IoT` from the :guilabel:`Select the
|
||||
type of install` drop-down menu.
|
||||
|
||||
.. example::
|
||||
For reference, the following should be installed:
|
||||
|
||||
- **Odoo server**
|
||||
- **Odoo IoT**
|
||||
- **Nginx WebServer**
|
||||
- **Ghostscript interpreter**
|
||||
|
||||
Ensure there is enough space on the computer for the installation and click :guilabel:`Next`.
|
||||
|
||||
Setting the destination and completing the installation
|
||||
-------------------------------------------------------
|
||||
|
||||
To complete the installation, select the :guilabel:`Destination Folder` and click
|
||||
:guilabel:`Install`.
|
||||
|
||||
.. tip::
|
||||
Choosing ``C:\odoo`` as the install location will allow for the Nginx server to start. If the
|
||||
folder doesn't exist, then create it. Otherwise the installation files will be spread throughout
|
||||
the hard drive.
|
||||
|
||||
.. warning::
|
||||
Odoo's Windows virtual IoT software should not be installed inside any of the Window's User's
|
||||
directories. Doing so will not allow for Nginx to initialize.
|
||||
|
||||
The installation may take a few minutes. When complete, click :guilabel:`Next` to continue.
|
||||
|
||||
Ensure that the :guilabel:`Start Odoo` box is checked and click :guilabel:`Finish`. After
|
||||
installation, the Odoo server will run and automatically open `http://localhost:8069` on a web
|
||||
browser. The webpage should display the :abbr:`IoT (Internet of Things)` box homepage.
|
||||
|
||||
.. seealso::
|
||||
A restart of the Windows IoT program may be necessary should the web browser not display
|
||||
anything. :ref:`iot/restart_windows_iot`
|
||||
|
||||
Connecting devices
|
||||
------------------
|
||||
|
||||
Next, connect the :abbr:`IoT (Internet of Things)` devices to the Windows computer. Windows should
|
||||
automatically detect the device because the driver is pre-installed on the computer. If not, search
|
||||
for and install the Windows driver for the device.
|
||||
|
||||
.. important::
|
||||
Most devices connect to the Windows Machine for Windows IoT automatically through Windows
|
||||
Plug-N-Play (PnP). However, if Windows does not automatically recognize the device after
|
||||
connecting, then the administrator may need to install the corresponding drivers manually.
|
||||
|
||||
Devices automatically recognized:
|
||||
|
||||
- Regular ink/toner based printers
|
||||
- Receipt printers (Epson/Star)
|
||||
- Barcode scanners
|
||||
- Measurement devices (although some configuration of the measurement device settings is
|
||||
required) See this documentation: :doc:`../devices/measurement_tool`
|
||||
|
||||
Devices not automatically recognized (requires manual driver download):
|
||||
|
||||
- Label printers (Zebra)
|
||||
- Scales
|
||||
|
||||
Reference the manufacturer's website for the equipment in question. Then, download the drivers
|
||||
and install them on the Windows machine. Reconnect the device in question and Windows will find
|
||||
the device.
|
||||
|
||||
Following connecting devices to the computer, refresh the :abbr:`IoT (Internet of Things)` box
|
||||
homepage and verify the device is seen. If not, reload the handlers through the :abbr:`IoT (Internet
|
||||
of Things)` box homepage.
|
||||
|
||||
Finally, connect Windows :abbr:`IoT (Internet of Things)` to a database using existing instructions
|
||||
(manually using the Token).
|
||||
|
||||
.. seealso::
|
||||
:doc:`/applications/general/iot/config/connect`
|
||||
|
||||
Now the installation is complete, the devices connected to :abbr:`IoT (Internet of Things)` can be
|
||||
used to complete processes/actions.
|
||||
|
||||
Troubleshooting
|
||||
===============
|
||||
|
||||
.. _iot/restart_windows_iot:
|
||||
|
||||
Restart Windows IoT box
|
||||
-----------------------
|
||||
|
||||
In some instances a manual restart of the physical :abbr:`IoT (Internet of Things)` box can resolve
|
||||
the issue of an :abbr:`IoT (Internet of Things)` box not showing up on the database. For the Windows
|
||||
virtual :abbr:`IoT (Internet of Things)` box a manual restart of the Odoo server can resolve
|
||||
database connection issues.
|
||||
|
||||
To restart the virtual Windows IoT server:
|
||||
|
||||
#. Type `Services` into the Windows :guilabel:`Search Bar`.
|
||||
#. Select the :menuselection:`Services` App and scroll down to the :guilabel:`Odoo` service.
|
||||
#. Right click on :guilabel:`Odoo` and select :guilabel:`Start` or :guilabel:`Restart`. This action
|
||||
will manually restart the Odoo IoT server.
|
||||
|
||||
Firewalls
|
||||
---------
|
||||
|
||||
Firewalls keep devices safe and secure. Sometimes they can block connections that should be made
|
||||
though. The Windows virtual :abbr:`IoT (Internet of Things)` box software may not be reachable to
|
||||
the :abbr:`LAN (Local Area Network)` due to a firewall preventing the connection. Consult your local
|
||||
IT support team to make exceptions (network discovery) in the :abbr:`OS (Operating System)` or
|
||||
firewall program. Windows has their own firewall as do other virus protection programs.
|
||||
|
||||
.. example::
|
||||
A client might encounter a time when they are able to reach the homepage of the :abbr:`IoT
|
||||
(Internet of Things)` box, yet they cannot access it from another computer/mobile device/tablet
|
||||
on the same network.
|
||||
|
||||
Making an exception on Windows Defender
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
It is possible to allow other devices to access the Windows virtual :abbr:`IoT (Internet of Things)`
|
||||
box while keeping the firewall on. This is done by creating a rule on *Windows Defender* and
|
||||
allowing communication through port `8069`. The following process describes the steps to take in
|
||||
order to make this exception.
|
||||
|
||||
Create a rule in Windows Defender
|
||||
*********************************
|
||||
|
||||
First, open the *Windows Firewall* by navigating to the :menuselection:`Start Menu` and typing in
|
||||
`Firewall`. Then, open the :menuselection:`Windows Defender Firewall` program. In the left-hand
|
||||
menu, navigate to :guilabel:`Advanced Settings`.
|
||||
|
||||
Once :guilabel:`Advanced Settings` have been selected, click :guilabel:`Inbound Rules` in the
|
||||
left-hand menu. Then, in the right-hand menu column (under :guilabel:`Inbound Rules`), click on
|
||||
:guilabel:`New Rule` to create a new rule.
|
||||
|
||||
Configure new rule
|
||||
******************
|
||||
|
||||
On the :menuselection:`Rule Type` screen, select :guilabel:`Port`. Then click :guilabel:`Next`. From
|
||||
the :menuselection:`Protocol and Ports` page leave the rule application to :guilabel:`TCP`. Then,
|
||||
select :guilabel:`Specific Local Ports` for the :guilabel:`ports` option. In the text box, type in
|
||||
`8069`. Finally click :guilabel:`Next` to continue to the next step.
|
||||
|
||||
On the :menuselection:`Actions` page, select :guilabel:`Allow the connection` and click
|
||||
:guilabel:`Next`. The following page on the :menuselection:`Rule Configuration` wizard is the
|
||||
:guilabel:`Profile` page. On this page, select whichever connection type applies to the network the
|
||||
Windows machine is operating on. Ideally, select :guilabel:`Private` only connections. The *Private*
|
||||
connection type is the most secure connection while allowing the selected port to communicate. Click
|
||||
:guilabel:`Next` to continue.
|
||||
|
||||
Finally, assign a new, unique name to the rule. For example, this name can be `Odoo`. Optionally,
|
||||
add a brief description in the :guilabel:`Description` field. Click :guilabel:`Finish` to complete
|
||||
the :guilabel:`Rule Configuration` wizard. Now, the new rule is active and devices can connect to
|
||||
the Windows virtual :abbr:`IoT (Internet of Things)` box.
|
||||
|
||||
Worldline exception
|
||||
~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
*Worldline* is a payment terminal that can be connected to Odoo's *PoS* (point of sale) system. It
|
||||
allows for a comprehensive and fluid payment experience for customers. Worldline is available in
|
||||
Benelux (coalition of Belgium, the Netherlands, and Luxembourg).
|
||||
|
||||
When using the Windows IoT server to connect the Worldline payment terminal, it is necessary to
|
||||
create an exception in the Windows firewall so that a connection can be made between the Odoo
|
||||
database/:abbr:`IoT (Internet of Things)` box and Worldline.
|
||||
|
||||
.. seealso::
|
||||
:doc:`../../../sales/point_of_sale/payment_methods/terminals/worldline`
|
||||
|
||||
To create the exception, first, open the *Windows Defender Firewall* app on the Windows machine.
|
||||
This can be accomplished by typing `windows defender` in the :guilabel:`Search` bar.
|
||||
|
||||
Next, click :guilabel:`Advanced settings` in the left menu.
|
||||
|
||||
.. image:: windows_iot/advanced-settings.png
|
||||
:align: center
|
||||
:alt: Advanced settings option highlighted in the left pane of the Windows Defender Firewall app.
|
||||
|
||||
In the left menu, choose :guilabel:`Inbound Rules`.
|
||||
|
||||
.. image:: windows_iot/inbound-rules.png
|
||||
:align: center
|
||||
:alt: Windows Defender left window pane with inbound rules menu item highlighted.
|
||||
|
||||
After selecting :guilabel:`Inbound Rules`, select :guilabel:`New Rule` in the far right menu.
|
||||
|
||||
.. image:: windows_iot/new-rule.png
|
||||
:align: center
|
||||
:alt: New rule dropdown shown with new rule option highlighted.
|
||||
|
||||
Then, for the :guilabel:`Rule Type`, select the radio button for :guilabel:`Port`. Click
|
||||
:guilabel:`Next` to continue to the rest of the configuration.
|
||||
|
||||
.. image:: windows_iot/radio-port.png
|
||||
:align: center
|
||||
:alt: Rule Type window open, with the radio button next to port highlighted.
|
||||
|
||||
On the :guilabel:`Protocols and Ports` page, choose the radio button for :guilabel:`TCP`, under
|
||||
:guilabel:`Does this rule apply to TCP or UDP?`.
|
||||
|
||||
Next, under :guilabel:`Does this rule apply to all local ports or specific ports?`, select the radio
|
||||
button for :guilabel:`Specific local ports`. Then, enter `9050`, and click :guilabel:`Next` to
|
||||
continue.
|
||||
|
||||
.. image:: windows_iot/protocol-port.png
|
||||
:align: center
|
||||
:alt: Protocol/port configuration window with TCP, specific port (9050) and Next highlighted.
|
||||
|
||||
The next screen is the :guilabel:`Action` page. Under :guilabel:`What action should be taken when a
|
||||
connection matches the specified conditions?`, choose the radio button for :guilabel:`Allow the
|
||||
connection`. Then, click :guilabel:`Next` to continue.
|
||||
|
||||
A :guilabel:`Profile` page appears. Under :guilabel:`When does this rule apply?`, leave the three
|
||||
boxes checked for: :guilabel:`Domain`, :guilabel:`Private`, and :guilabel:`Public`. Click
|
||||
:guilabel:`Next` to continue to the naming convention page.
|
||||
|
||||
On the :guilabel:`Name` page, enter `Odoo Worldline`, under the :guilabel:`Name` field. Enter a
|
||||
:guilabel:`Description (optional)`. Finally, once ready, click :guilabel:`Finish`.
|
||||
|
||||
The final :guilabel:`Inbound rule` should appear as follows:
|
||||
|
||||
.. list-table::
|
||||
:header-rows: 1
|
||||
:stub-columns: 1
|
||||
|
||||
* -
|
||||
- Odoo Worldline
|
||||
* - Profile
|
||||
- All
|
||||
* - Enabled
|
||||
- Yes
|
||||
* - Action
|
||||
- Allow
|
||||
* - Override
|
||||
- No
|
||||
* - Program
|
||||
- Any
|
||||
* - Local Address
|
||||
- Any
|
||||
* - Remote Address
|
||||
- Any
|
||||
* - Protocol
|
||||
- TCP
|
||||
* - Local Port
|
||||
- 9050
|
||||
* - Remote Port
|
||||
- Any
|
||||
* - Authorized Users
|
||||
- Any
|
||||
* - Authorized Computers
|
||||
- Any
|
||||
* - Authorized Local Principals
|
||||
- Any
|
||||
* - Local User Owner
|
||||
- Any
|
||||
* - PolicyAppld
|
||||
- None
|
||||
* - Application Package
|
||||
- Any
|
||||
|
||||
Uninstalling Windows IoT
|
||||
------------------------
|
||||
|
||||
Uninstalling the Windows virtual :abbr:`IoT (Internet of Things)` box is done through the Windows
|
||||
program manager. Using any Windows version, search for `program`. Then, select :guilabel:`Add or
|
||||
Remove Programs` located in the control panel. Search for `Odoo` and click the :guilabel:`three dot
|
||||
menu` to uninstall.
|
||||
|
||||
Confirm the un-installation and follow the steps to uninstall through the Odoo uninstall guide.
|
||||
|
After Width: | Height: | Size: 16 KiB |
|
After Width: | Height: | Size: 34 KiB |
|
After Width: | Height: | Size: 5.6 KiB |
|
After Width: | Height: | Size: 39 KiB |
|
After Width: | Height: | Size: 17 KiB |
@@ -0,0 +1,16 @@
|
||||
:nosearch:
|
||||
|
||||
=======
|
||||
Devices
|
||||
=======
|
||||
|
||||
.. toctree::
|
||||
:titlesonly:
|
||||
:glob:
|
||||
|
||||
devices/screen
|
||||
devices/measurement_tool
|
||||
devices/camera
|
||||
devices/footswitch
|
||||
devices/printer
|
||||
devices/scale
|
||||
@@ -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`
|
||||
|
After Width: | Height: | Size: 5.9 KiB |
|
After Width: | Height: | Size: 42 KiB |
|
After Width: | Height: | Size: 9.6 KiB |
@@ -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`
|
||||
|
After Width: | Height: | Size: 6.3 KiB |
|
After Width: | Height: | Size: 10 KiB |
@@ -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`
|
||||
|
After Width: | Height: | Size: 8.0 KiB |
|
After Width: | Height: | Size: 4.6 KiB |
|
After Width: | Height: | Size: 67 KiB |
@@ -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.
|
||||
|
After Width: | Height: | Size: 10 KiB |
|
After Width: | Height: | Size: 11 KiB |
|
After Width: | Height: | Size: 5.4 KiB |
|
After Width: | Height: | Size: 10 KiB |
|
After Width: | Height: | Size: 16 KiB |
@@ -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.
|
||||
|
After Width: | Height: | Size: 32 KiB |
|
After Width: | Height: | Size: 24 KiB |
|
After Width: | Height: | Size: 5.5 KiB |
|
After Width: | Height: | Size: 4.5 KiB |
|
After Width: | Height: | Size: 5.7 KiB |
@@ -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.
|
||||
|
After Width: | Height: | Size: 3.2 KiB |
|
After Width: | Height: | Size: 88 KiB |
|
After Width: | Height: | Size: 29 KiB |
|
After Width: | Height: | Size: 1.0 KiB |
|
After Width: | Height: | Size: 7.4 KiB |
|
After Width: | Height: | Size: 3.1 KiB |