[IMP] IoT: edits to all IoT docs
closes odoo/documentation#4921
X-original-commit: e7457c992b
Signed-off-by: Zachary Straub (zst) <zst@odoo.com>
This commit is contained in:
Timothy Kukulka (tiku)
committed by
tiku-odoo
tiku-odoo
parent
eb8a257049
commit
da9b9d68ff
@@ -1,81 +1,181 @@
|
||||
===================================
|
||||
Connect an IoT Box to your database
|
||||
===================================
|
||||
==========================
|
||||
Connect an IoT box to Odoo
|
||||
==========================
|
||||
|
||||
Install the Internet of Things (IoT) App on your Odoo Database.
|
||||
An Internet of Things (IoT) box is a micro-computer device that allows for the connection of input
|
||||
and output devices to an Odoo database. An :abbr:`IoT (Internet of Things)` box subscription is
|
||||
required in order to use the :abbr:`IoT (Internet of Things)` box with a secured connection. A
|
||||
computer is also required to set up the :abbr:`IoT (Internet of Things)` box.
|
||||
|
||||
.. image:: connect/connect01.png
|
||||
.. seealso::
|
||||
`IoT Box FAQ <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.
|
||||
|
||||
Go in the IoT App and click on Connect on the IoT Boxes page.
|
||||
Next, after the *IoT app* is installed, navigate to :menuselection:`IoT app --> IoT Boxes`, and then
|
||||
click on the :guilabel:`Connect` button located in the upper-left corner of the :menuselection:`IoT
|
||||
Boxes` dashboard.
|
||||
|
||||
.. image:: connect/connect02.png
|
||||
.. image:: connect/connect-iot.png
|
||||
:align: center
|
||||
:alt: Connecting an IoT box to the Odoo database.
|
||||
|
||||
Follow the steps to connect your IoT Box.
|
||||
There are two recommended ways to connect the :abbr:`IoT (Internet of Things)` box to the database
|
||||
once the *IoT app* is installed. Follow the steps in either of the next two sections to connect the
|
||||
:abbr:`IoT (Internet of Things)` box via :ref:`wired ethernet connection <iot_connect/ethernet>` or
|
||||
via :ref:`WiFi <iot_connect/wifi>`.
|
||||
|
||||
.. image:: connect/connect03.png
|
||||
.. image:: connect/connect-iot-box.png
|
||||
:align: center
|
||||
:alt: Connection steps for a wired connection or WiFi connection.
|
||||
|
||||
Ethernet Connection
|
||||
.. important::
|
||||
The disk image that the :abbr:`IoT (Internet of Things)` box SD card is formatted with is unique
|
||||
to the version of the Odoo database that the :abbr:`IoT (Internet of Things)` box is running on.
|
||||
Ensure that the :abbr:`IoT (Internet of Things)` box is :doc:`flashed <flash_sdcard>` with the
|
||||
most up-to-date disk image.
|
||||
|
||||
.. _iot_connect/ethernet:
|
||||
|
||||
Ethernet connection
|
||||
===================
|
||||
|
||||
#. Connect to the IoT Box all the devices that have to be connected with
|
||||
cables (ethernet, usb devices, etc.).
|
||||
The following is the process to connect the :abbr:`IoT (Internet of Things)` box via an ethernet
|
||||
cable to the Odoo database (by way of the ethernet port; RJ-45).
|
||||
|
||||
#. Power on the IoT Box.
|
||||
First, connect all wired devices to the :abbr:`IoT (Internet of Things)` box (ethernet, :abbr:`USB
|
||||
(Universal Serial Bus)` devices, etc.). At minimum, an HDMI screen should be connected. Then, plug
|
||||
the :abbr:`IoT (Internet of Things)` box into a power source.
|
||||
|
||||
#. Read the Pairing Code from a screen or a receipt printer connected to the IoT Box.
|
||||
Immediately after the unit powers on and boots up, read the *pairing code* from the screen or from
|
||||
the printout of a receipt printer connected to the :abbr:`IoT (Internet of Things)` box.
|
||||
|
||||
.. image:: connect/connect04.png
|
||||
|
||||
#. Input the Pairing Code and click on the Pair button.
|
||||
.. warning::
|
||||
By default, the :abbr:`IoT (Internet of Things)` box will display the *pairing code* for a
|
||||
maximum of 5 minutes after the unit boots up. After 5 minutes, the *pairing code* will disappear
|
||||
for security purposes and the :abbr:`IoT (Internet of Things)` box will need to be rebooted
|
||||
manually by unplugging the unit from the power source for ten seconds and re-plugging it back in.
|
||||
|
||||
.. note::
|
||||
Recent changes in modern web browsers forced us to modify the connection wizard.
|
||||
If your screen is different from the screenshots, make sure that the
|
||||
``iot_pairing`` module is installed.
|
||||
If no screen is attached to the :abbr:`IoT (Internet of Things)` box, then the *pairing code* can
|
||||
be accessed from the :abbr:`IoT (Internet of Things)` box homepage by clicking on the
|
||||
:guilabel:`POS Display` button. For instructions on how to access the :abbr:`IoT (Internet of
|
||||
Things)` box homepage visit :ref:`iot_connect/token`.
|
||||
|
||||
WiFi Connection
|
||||
On the computer, navigate to :menuselection:`IoT app --> IoT Boxes`, and then click on the
|
||||
:guilabel:`Connect` button located in the upper-left corner of the the :menuselection:`IoT Boxes`
|
||||
dashboard. Input the *pairing code* in the :guilabel:`Pairing Code` field and click on the
|
||||
:guilabel:`Pair` button. The database will now link to the :abbr:`IoT (Internet of Things)` box and
|
||||
it will appear on the :menuselection:`IoT Boxes` page.
|
||||
|
||||
.. _iot_connect/wifi:
|
||||
|
||||
WiFi connection
|
||||
===============
|
||||
|
||||
#. Power on the IoT Box
|
||||
The following is the process to connect the :abbr:`IoT (Internet of Things)` box via a WiFi
|
||||
connection to the Odoo database.
|
||||
|
||||
#. Copy the token
|
||||
First, ensure there is no ethernet cable plugged into the :abbr:`IoT (Internet of Things)` box.
|
||||
Then, connect all wired devices to the :abbr:`IoT (Internet of Things)` box (:abbr:`USB (Universal
|
||||
Serial Bus)` devices, etc.).
|
||||
|
||||
.. image:: connect/connect05.png
|
||||
After connecting the devices, plug the :abbr:`IoT (Internet of Things)` box into to a power source.
|
||||
On the computer, navigate to :menuselection:`IoT app --> IoT Boxes`, and then click on the
|
||||
:guilabel:`Connect` button located in the upper-left corner of the the :menuselection:`IoT Boxes`
|
||||
dashboard. Then copy the :guilabel:`Token` from the :guilabel:`WiFi connection` section as this will
|
||||
later be used to link the Odoo database to the :abbr:`IoT (Internet of Things)` box.
|
||||
|
||||
#. Connect to the IoT Box WiFi Network (make sure there is no ethernet
|
||||
cable plugged in your computer).
|
||||
Back on the computer, navigate to the available WiFi networks and connect to the :abbr:`IoT
|
||||
(Internet of Things)` box WiFi network. The WiFi network dispersed by the :abbr:`IoT (Internet of
|
||||
Things)` box will start with `IoTBox-xxxxxxxxxx`.
|
||||
|
||||
.. image:: connect/connect06.png
|
||||
|
||||
#. You will be redirected to the IoT Box Homepage (if it doesn't work,
|
||||
connect to the IP address of the box). Give a name to your IoT Box (not
|
||||
required) and paste the token, then click on next.
|
||||
|
||||
.. image:: connect/connect07.png
|
||||
|
||||
.. tip::
|
||||
If you are on Runbot, do not forget to add the -all or -base in the
|
||||
token (e.g. this token
|
||||
**http://375228-saas-11-5-iot-f3f920.runbot16.odoo.com\|4957098401**
|
||||
should become
|
||||
**http://375228-saas-11-5-iot-f3f920-all.runbot16.odoo.com\|4957098401**).
|
||||
|
||||
#. Choose the WiFi network you want to connect with (enter the password
|
||||
if there is one) and click on Submit. Wait a few seconds before being
|
||||
redirected to your database.
|
||||
|
||||
.. image:: connect/connect08.png
|
||||
|
||||
You should now see the IoT Box.
|
||||
|
||||
.. image:: connect/connect09.png
|
||||
.. image:: connect/connect-iot-wifi.png
|
||||
:align: center
|
||||
:alt: WiFi networks available on the computer.
|
||||
|
||||
IoT Box Schema
|
||||
Upon connecting to the :abbr:`IoT (Internet of Things)` box WiFi, a browser will automatically
|
||||
redirect to the :menuselection:`Configure Iot Box` wizard. Name the :abbr:`IoT (Internet of Things)`
|
||||
box, then paste the previously copied *token* into the :guilabel:`Server Token` field, and then
|
||||
click on :guilabel:`Next`.
|
||||
|
||||
.. image:: connect/server-token.png
|
||||
:align: center
|
||||
:alt: Enter the server token into the IoT box.
|
||||
|
||||
.. note::
|
||||
If the :abbr:`IoT (Internet of Things)` box WiFi connection wizard doesn't start, then see the
|
||||
documentation on :ref:`connecting with a token <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
|
||||
==============
|
||||
|
||||
.. image:: connect/connect10.png
|
||||
:align: center
|
||||
Raspberry Pi 4
|
||||
--------------
|
||||
|
||||
.. figure:: connect/iot-box-schema.png
|
||||
|
||||
The Odoo IoT box (Raspberry Pi 4) schema with labels.
|
||||
|
||||
Raspberry Pi 3
|
||||
--------------
|
||||
|
||||
.. figure:: connect/iox-box-schema-3.png
|
||||
|
||||
The Odoo IoT box (Raspberry Pi 3) schema with labels.
|
||||
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 61 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 48 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 53 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 8.6 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 3.0 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 52 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 10 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 23 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 91 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 9.6 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 8.0 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 2.5 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 31 KiB |
|
Before Width: | Height: | Size: 3.8 KiB After Width: | Height: | Size: 3.8 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 21 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 12 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 11 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 33 KiB |
@@ -1,37 +1,68 @@
|
||||
=====================
|
||||
Flashing your SD Card
|
||||
=====================
|
||||
====================
|
||||
Flashing the SD card
|
||||
====================
|
||||
|
||||
In some case, you may need to reflash your IoT Box’s SD Card to benefit
|
||||
from our latest updates.
|
||||
In some circumstances, the :abbr:`IoT (Internet of Things)` box's micro SD Card may need to be
|
||||
re-flashed to benefit from Odoo's latest :abbr:`IoT (Internet of Things)` image update. This means
|
||||
that the Odoo :abbr:`IoT (Internet of Things)` box software may need to be updated.
|
||||
|
||||
Upgrade from the IoT Box homepage
|
||||
=================================
|
||||
Upgrade from the IoT box home page
|
||||
==================================
|
||||
|
||||
Go to the IoT Box homepage, click on *Update*, next to the version number.
|
||||
If a new version of the IoT Box image is available, you will see a
|
||||
*Upgrade to ___* button a the bottom of the page, the IoT Box will then
|
||||
flash itself to the new version of the IoT Box. All of your configurations
|
||||
will be saved.
|
||||
Go to the :abbr:`IoT (Internet of Things)` box homepage by navigating to :menuselection:`IoT app -->
|
||||
IoT Boxes` and clicking on the :guilabel:`IP address` of the :abbr:`IoT (Internet of Things)` box.
|
||||
Then click on :guilabel:`Update` (next to the version number).
|
||||
|
||||
If a new version of the :abbr:`IoT (Internet of Things)` Box image is available, an
|
||||
:guilabel:`Upgrade to _xx.xx_` button will appear at the bottom of the page. Click this button to
|
||||
upgrade the unit and the :abbr:`IoT (Internet of Things)` box will then flash itself to the new
|
||||
version. All of the previous configurations will be saved.
|
||||
|
||||
.. note::
|
||||
This process can take more than 30 minutes. Do not turn off or unplug
|
||||
the IoT Box as it would leave it in an inconsistent state.
|
||||
This process can take more than 30 minutes. Do not turn off or unplug the :abbr:`IoT (Internet of
|
||||
Things)` box as it would leave it in an inconsistent state. This means that the :abbr:`IoT
|
||||
(Internet of Things)` box will need to be re-flashed with a new image. See
|
||||
:ref:`flash_sdcard/etcher`.
|
||||
|
||||
.. image:: flash_sdcard/flash_sdcard01.png
|
||||
.. image:: flash_sdcard/flash-upgrade.png
|
||||
:align: center
|
||||
:alt: IoT box software upgrade in the IoT Box Home Page.
|
||||
|
||||
Upgrade with Etcher
|
||||
===================
|
||||
.. _flash_sdcard/etcher:
|
||||
|
||||
Go to Balena’s website and download `Etcher <https://www.balena.io/>`__.
|
||||
It’s a free and open-source utility used for burning image files.
|
||||
Install and launch it. Download the latest image from `nightly
|
||||
<http://nightly.odoo.com/master/iotbox/>`__.
|
||||
Upgrade with Etcher Software
|
||||
============================
|
||||
|
||||
Then, open *Etcher* and select *Flash from file*, find the image you just
|
||||
downloaded. Insert the IoT Box SD card into your computer and select it.
|
||||
Click on *Flash* and wait for the process to finish.
|
||||
.. note::
|
||||
A computer with a micro SD card reader/adapter is required in order to re-flash the micro SD
|
||||
card.
|
||||
|
||||
.. image:: flash_sdcard/flash_sdcard02.png
|
||||
Navigate to Balena's website and download `Etcher <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/>`_.
|
||||
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 24 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 115 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 79 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 17 KiB |
@@ -1,67 +1,67 @@
|
||||
===========================
|
||||
Use the IoT Box for the PoS
|
||||
===========================
|
||||
|
||||
.. image:: pos/pos01.png
|
||||
:align: center
|
||||
=========================
|
||||
Use an IoT box with a PoS
|
||||
=========================
|
||||
|
||||
Prerequisites
|
||||
=============
|
||||
|
||||
Before starting, make sure you have the following:
|
||||
Before starting, make sure the following equipment is available:
|
||||
|
||||
- An IoT Box, with its power adapter.
|
||||
- An :abbr:`IoT (Internet of Things)` box, with its power adapter.
|
||||
- A computer or tablet with an up-to-date web browser.
|
||||
- Odoo Online or an Odoo instance with the *Point of Sale* and *IoT* applications installed.
|
||||
- A local network set up with :abbr:`DHCP (Dynamic Host Configuration Protocol)` (this is the
|
||||
default setting).
|
||||
- An RJ45 Ethernet Cable (optional, but preferred over WiFi, which is already built in).
|
||||
- Any of the supported hardware (receipt printer, barcode scanner, cash drawer, payment terminal,
|
||||
scale, customer display, etc.). The list of supported hardware can be found on the `POS Hardware
|
||||
page <https://www.odoo.com/page/point-of-sale-hardware>`_.
|
||||
|
||||
- A computer or tablet with an up-to-date web browser
|
||||
Setup
|
||||
=====
|
||||
|
||||
- A running Odoo Online or Odoo instance with the Point of Sale and IoT apps
|
||||
installed
|
||||
.. figure:: pos/pos-connections.png
|
||||
|
||||
- A local network setup with DHCP (this is the default setting)
|
||||
A suggested configuration for a point of sale system.
|
||||
|
||||
- An RJ45 Ethernet Cable (optional, WiFi is built in)
|
||||
To connect hardware to the :abbr:`PoS (Point of Sale)`, the first step is to connect an :abbr:`IoT
|
||||
(Internet of Things)` box to the database. To do this, follow these instructions: :doc:`Connect an
|
||||
Internet of Things (IoT) box to the Odoo database <connect>`.
|
||||
|
||||
- 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>`__
|
||||
Then, connect the peripheral devices to the :abbr:`IoT (Internet of Things)` box.
|
||||
|
||||
Set Up
|
||||
======
|
||||
.. list-table::
|
||||
:header-rows: 1
|
||||
:stub-columns: 1
|
||||
|
||||
To connect hardware to the PoS, the first step is to connect an IoT Box
|
||||
to your database. For this, follow this
|
||||
:doc:`documentation <connect>`.
|
||||
* - Device Name
|
||||
- Instructions
|
||||
* - Printer
|
||||
- Connect a supported receipt printer to a :abbr:`USB (Universal Serial Bus)` port or
|
||||
to the network, and power it on. Refer to
|
||||
:doc:`/applications/sales/point_of_sale/restaurant/kitchen_printing`.
|
||||
* - Cash drawer
|
||||
- The cash drawer should be connected to the printer with an RJ25 cable.
|
||||
* - Barcode scanner
|
||||
- In order for the barcode scanner to be compatible it must end barcodes with an `ENTER`
|
||||
character (keycode 28). This is most likely the default configuration of the barcode scanner.
|
||||
* - Scale
|
||||
- Connect the scale and power it on. Refer to
|
||||
:doc:`/applications/productivity/iot/devices/scale`.
|
||||
* - Customer display
|
||||
- Connect a screen to the :abbr:`IoT (Internet of Things)` box to display the :abbr:`PoS (Point
|
||||
of Sale)` order. Refer to :doc:`/applications/productivity/iot/devices/screen`.
|
||||
* - Payment terminal
|
||||
- The connection process depends on the terminal. Refer to the :doc:`payment terminals
|
||||
documentation </applications/sales/point_of_sale/payment_methods>`.
|
||||
|
||||
Then, you have to connect the peripheral devices to your IoT Box.
|
||||
Once this is completed, connect the :abbr:`IoT (Internet of Things)` box to the :menuselection:`PoS`
|
||||
application. To do this, go to :menuselection:`Point of Sale --> Configuration --> PoS`, tick the
|
||||
:guilabel:`IoT Box` option, and select the devices to be used in this :abbr:`PoS (Point of Sale)`.
|
||||
:guilabel:`Save` the the changes.
|
||||
|
||||
- **Printer**: Connect a supported receipt printer to a USB port or to
|
||||
the network and power it on.
|
||||
|
||||
- **Cash drawer**: The cash drawer should be connected to the printer
|
||||
with an RJ25 cable.
|
||||
|
||||
- **Barcode scanner**: Connect your barcode scanner. In order for your
|
||||
barcode scanner to be compatible it must end barcodes with an Enter
|
||||
character (keycode 28). This is most likely the default configuration
|
||||
of your barcode scanner.
|
||||
|
||||
- **Scale**: Connect your scale and power it on.
|
||||
|
||||
- **Customer Display**: Connect a screen to the IoT Box to display the
|
||||
PoS order. Please refer to
|
||||
:doc:`/applications/productivity/iot/devices/screen`.
|
||||
|
||||
- **Payment terminal**: The connection process depends on the terminal,
|
||||
please refer to the :doc:`payment terminals documentation
|
||||
</applications/sales/point_of_sale/payment_methods>`.
|
||||
|
||||
Once it's done, you can connect the IoT Box to your PoS. For this, go in
|
||||
:menuselection:`Point of Sale --> Configuration --> PoS`, tick *IoT Box*
|
||||
and select the devices you want to use in this Point of Sale. Save the
|
||||
changes.
|
||||
|
||||
.. image:: pos/pos02.png
|
||||
.. image:: pos/iot-connected-devices.png
|
||||
:align: center
|
||||
:alt: Configuring the connected devices in the POS application.
|
||||
|
||||
Set up is done, you can launch a new PoS Session.
|
||||
Once set up is done, a new :abbr:`PoS (Point of Sale)` session can be launched.
|
||||
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 7.5 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 26 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 30 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 28 KiB |
@@ -2,133 +2,156 @@
|
||||
Troubleshooting
|
||||
===============
|
||||
|
||||
IoT Box Connection
|
||||
IoT box connection
|
||||
==================
|
||||
|
||||
I can't find the pairing code to connect my IoT Box
|
||||
---------------------------------------------------
|
||||
Unable to locate the pairing code to connect the IoT box
|
||||
--------------------------------------------------------
|
||||
|
||||
The pairing code should be printed on receipt printers connected to the
|
||||
IoT Box and should also be displayed on connected monitors.
|
||||
The pairing code should be printed on receipt printers connected to the :abbr:`IoT (Internet of
|
||||
Things)` box and should also be displayed on connected monitors.
|
||||
|
||||
The pairing code doesn't show under the following circumstances:
|
||||
|
||||
- The IoT Box is already connected to an Odoo database;
|
||||
- The :abbr:`IoT (Internet of Things)` box is already connected to an Odoo database.
|
||||
- The :abbr:`IoT (Internet of Things)` box is not connected to the Internet.
|
||||
- The code is only valid for 5 minutes after the :abbr:`IoT (Internet of Things)` box has started.
|
||||
It's automatically removed from connected displays when this time has expired.
|
||||
- The version of the :abbr:`IoT (Internet of Things)` box image is too old. If the :abbr:`IoT
|
||||
(Internet of Things)` box image is from an earlier version, then the SD card of the :abbr:`IoT
|
||||
(Internet of Things)` box will need to be re-flashed to update the image (see :doc:`Flashing the
|
||||
SD Card <flash_sdcard>`).
|
||||
|
||||
- The IoT Box is not connected to the Internet;
|
||||
If none of the cases listed above correct the issue, then make sure that the :abbr:`IoT (Internet of
|
||||
Things)` box has correctly started, by checking that a fixed green LED is showing next to the power
|
||||
port.
|
||||
|
||||
- The code is only valid for 5 minutes after the IoT Box has started. It's
|
||||
automatically removed from connected displays when this delay has expired;
|
||||
IoT box is connected but it's not showing in the database
|
||||
---------------------------------------------------------
|
||||
|
||||
- The version of the IoT Box image is too old. It should use version 20.06
|
||||
or more recent. If your IoT Box image is from an earlier version, then
|
||||
you will have to reflash the SD card of your IoT Box to update the image
|
||||
(see :doc:`Flashing your SD Card <flash_sdcard>`)
|
||||
When an :abbr:`IoT (Internet of Things)` box connects to a database, it may restart. If so, it can
|
||||
take up to five minutes before appearing in the database. If the :abbr:`IoT (Internet of Things)`
|
||||
box is still not showing after five minutes, make sure that the :abbr:`IoT (Internet of Things)` box
|
||||
can reach the database and that the server doesn't use a multi-database environment.
|
||||
|
||||
If you are not in any of the cases listed above, make sure that the IoT Box
|
||||
has correctly started, by checking that a fixed green LED is showing next to
|
||||
the micro-USB port.
|
||||
To access the database from the :abbr:`IoT (Internet of Things)` box, open a browser and type in the
|
||||
database address.
|
||||
|
||||
I've connected my IoT Box but it's not showing in my database
|
||||
-------------------------------------------------------------
|
||||
The IoT box is connected to the Odoo database, but cannot be reached
|
||||
--------------------------------------------------------------------
|
||||
|
||||
When you connect an IoT Box to a database, the IoT Box might restart, if
|
||||
that is the case, it might take up to one minute before appearing in your
|
||||
database. If after some time the IoT is still not showing, make sure that
|
||||
your database can be reached from the IoT Box and that your server doesn't
|
||||
use a multi-database environment.
|
||||
Make sure that the :abbr:`IoT (Internet of Things)` box and the computer running the browser are
|
||||
located on the same network, as the :abbr:`IoT (Internet of Things)` box cannot be reached from
|
||||
outside the local network.
|
||||
|
||||
My IoT Box is connected to my database, but cannot be reached
|
||||
-------------------------------------------------------------
|
||||
The HTTPS certificate doesn't generate
|
||||
--------------------------------------
|
||||
|
||||
Make sure that the IoT Box and the device running the browser are located
|
||||
on the same network as the IoT Box cannot be reached from outside the local
|
||||
network.
|
||||
In order to generate a :abbr:`HTTPS (Hypertext Transfer Protocol Secure)` certificate, an IoT box
|
||||
subscription is required for the :abbr:`IoT (Internet of Things)` box. Connecting the :abbr:`IoT
|
||||
(Internet of Things)` box prior to configuring an :abbr:`IoT (Internet of Things)` subscription for
|
||||
the database and :abbr:`IoT (Internet of Things)` box with the Account Manager will result in an
|
||||
unsecured connection.
|
||||
|
||||
In addition, a firewall can also prevent the :abbr:`HTTPS (Hypertext Transfer Protocol Secure)`
|
||||
certificate from generating correctly. In this case, deactivate the firewall until the certificate
|
||||
is successfully generated. It should also be noted that certain devices, such as a router that has
|
||||
a built-in firewall, can prevent the :abbr:`HTTPS (Hypertext Transfer Protocol Secure)` certificate
|
||||
from generating.
|
||||
|
||||
.. seealso::
|
||||
:doc:`HTTPS certificate (IoT) <https_certificate_iot>`
|
||||
|
||||
Printer
|
||||
=======
|
||||
|
||||
My printer is not detected
|
||||
--------------------------
|
||||
The printer is not detected
|
||||
---------------------------
|
||||
|
||||
If one of your printers doesn't show up in your devices list, go to the
|
||||
IoT Box homepage and make sure that it is listed under *Printers*.
|
||||
If a printer doesn't show up in the devices list, go to the :abbr:`IoT (Internet of Things)` box
|
||||
homepage and make sure that it is listed under :guilabel:`Printers`.
|
||||
|
||||
.. image:: troubleshooting/troubleshooting_printer_01.png
|
||||
.. image:: troubleshooting/printer-status.png
|
||||
:align: center
|
||||
:alt: The IoT box Home Page landing page.
|
||||
|
||||
If your printer is not present on the IoT Box homepage, hit
|
||||
*Printers Server*, go to the *Administration* tab and click on
|
||||
*Add Printer*. If you can't find your printer in the list, it's probably
|
||||
not connected properly.
|
||||
If the printer is not present on the :abbr:`IoT (Internet of Things)` box homepage, click
|
||||
:guilabel:`Printers Server`, go to the :guilabel:`Administration` tab and click on :guilabel:`Add
|
||||
Printer`. If the printer is not present in the list, it's likely not connected properly.
|
||||
|
||||
My printer outputs random text
|
||||
------------------------------
|
||||
The printer outputs random text
|
||||
-------------------------------
|
||||
|
||||
For most printers, the correct driver should be automatically detected
|
||||
and selected. However, in some cases, the automatic detection mechanism
|
||||
might not be enough, and if no driver is found the printer might print
|
||||
random characters.
|
||||
For most printers, the correct driver should be automatically detected and selected. However, in
|
||||
some cases, the automatic detection mechanism might not be enough, and if no driver is found, the
|
||||
printer might print random characters.
|
||||
|
||||
The solution is to manually select the corresponding driver. On the IoT
|
||||
Box homepage, click on *Printers Server*, go to the *Printers*
|
||||
tab and select the printer in the list. In the Administration dropdown,
|
||||
click on *Modify Printer*. Follow the steps and select the Make and Model
|
||||
corresponding to your printer.
|
||||
The solution is to manually select the corresponding driver. On the :abbr:`IoT (Internet of Things)`
|
||||
box homepage, click on :guilabel:`Printers Server`, go to the :guilabel:`Printers` tab and select
|
||||
the printer in the list. In the :guilabel:`Administration` dropdown, click on :guilabel:`Modify
|
||||
Printer`. Follow the steps and select the *make* and *model* corresponding to the printer.
|
||||
|
||||
.. image:: troubleshooting/troubleshooting_printer_02.png
|
||||
.. image:: troubleshooting/modify-printer.png
|
||||
:align: center
|
||||
:alt: Edit the printer connected to the IoT box.
|
||||
|
||||
.. note::
|
||||
Epson and Star receipt printers and Zebra label printers do not
|
||||
need a driver to work. Make sure that no driver is selected for those
|
||||
printers.
|
||||
Epson and Star receipt printers and Zebra label printers do not need a driver to work. Make sure
|
||||
that no driver is selected for those printers.
|
||||
|
||||
My Zebra Printer doesn't print anything
|
||||
---------------------------------------
|
||||
The Zebra printer doesn't print anything
|
||||
----------------------------------------
|
||||
|
||||
Zebra printers are quite sensitive to the format of the ZPL code that is
|
||||
printed. If nothing comes out of the printer or blank labels are printed,
|
||||
try changing the format of the report that is sent to the printer by
|
||||
accessing :menuselection:`Settings ~~> Technical ~~> Views` in developer
|
||||
mode and look for the corresponding template.
|
||||
Zebra printers are quite sensitive to the format of the Zebra Programming Language (ZPL) code that
|
||||
is printed. If nothing comes out of the printer or blank labels are printed, try changing the format
|
||||
of the report that is sent to the printer by accessing :menuselection:`Settings --> Technical -->
|
||||
User Interface --> Views` in :ref:`developer mode <developer-mode>` and look for the corresponding
|
||||
template.
|
||||
|
||||
Barcode Scanner
|
||||
.. seealso::
|
||||
Check out Zebra's instructions on printing :abbr:`ZPL (Zebra Programming Language)` files
|
||||
`here
|
||||
<https://supportcommunity.zebra.com/s/article/Print-a-zpl-file-using-the-Generic-Text-Printer_>`_.
|
||||
|
||||
Barcode scanner
|
||||
===============
|
||||
|
||||
The characters read by the barcode scanner don't match the barcode
|
||||
------------------------------------------------------------------
|
||||
|
||||
By default, we assume that your barcode scanner is configured in US
|
||||
QWERTY. This is the default configuration of most barcode readers.
|
||||
If your barcode scanner uses a different layout, please go to the
|
||||
form view of your device and select the correct one.
|
||||
By default, most barcode scanners are configured in the US QWERTY format. If the barcode scanner
|
||||
uses a different layout, go to the form view of the device (:menuselection:`IoT App --> Devices -->
|
||||
Barcode Device`) and select the correct format.
|
||||
|
||||
Nothing happens when a barcode is scanned
|
||||
-----------------------------------------
|
||||
|
||||
Make sure that the correct device is selected in your Point of Sale
|
||||
configuration and that your barcode is configured to send an ENTER
|
||||
character (keycode 28) at the end of every barcode.
|
||||
Make sure that the correct device is selected in the :menuselection:`Point of Sale` configuration
|
||||
and that the barcode is configured to send an `ENTER` character (keycode 28) at the end of every
|
||||
barcode. To do so, navigate to :menuselection:`PoS app --> 3-Dot Menu on the PoS --> IoT Box section
|
||||
--> Edit`.
|
||||
|
||||
The barcode scanner is detected as a keyboard
|
||||
---------------------------------------------
|
||||
|
||||
Some poorly built barcode scanners do not advertise themselves as
|
||||
barcode scanners but as a USB keyboard instead, and will not be
|
||||
recognized by the IoT Box.
|
||||
.. important::
|
||||
Some barcode scanners do not advertise themselves as barcode scanners but as a USB keyboard
|
||||
instead, and will not be recognized by the :abbr:`IoT (Internet of Things)` box.
|
||||
|
||||
You can manually change the device type by going to its form view and
|
||||
activating the *Is scanner* option.
|
||||
The device type can be manually changed by going to its form view (:menuselection:`IoT App -->
|
||||
Devices --> Barcode Device`) and activating the :guilabel:`Is scanner` option.
|
||||
|
||||
.. image:: troubleshooting/troubleshooting_barcode_01.png
|
||||
.. image:: troubleshooting/barcode-scanner-settings.png
|
||||
:align: center
|
||||
:alt: Modifying the form view of the barcode scanner.
|
||||
|
||||
Cashdrawer
|
||||
==========
|
||||
Cash drawer
|
||||
===========
|
||||
|
||||
The cashdrawer does not open
|
||||
----------------------------
|
||||
The cash drawer does not open
|
||||
-----------------------------
|
||||
|
||||
The cashdrawer should be connected to the printer and the *Cashdrawer*
|
||||
checkbox should be ticked in the POS configuration.
|
||||
The cash drawer should be connected to the printer and the :guilabel:`Cash drawer` checkbox should
|
||||
be ticked in the :abbr:`PoS (Point of Sale)` configuration. To do so, navigate to
|
||||
:menuselection:`POS app --> 3-Dot Menu on the POS --> IoT Box section --> Edit --> Receipt Printer
|
||||
--> Cashdrawer checkbox`.
|
||||
|
||||
|
Before Width: | Height: | Size: 15 KiB After Width: | Height: | Size: 15 KiB |
|
Before Width: | Height: | Size: 35 KiB After Width: | Height: | Size: 35 KiB |
|
Before Width: | Height: | Size: 54 KiB After Width: | Height: | Size: 54 KiB |
Reference in New Issue
Block a user