Files
odoo-docs/content/applications/general/iot/iot_box.rst
Audrey (auva) 03a11048b6 [IMP] iot: 19.0 updates
task-5108135
2025-12-11 13:41:43 +01:00

137 lines
5.1 KiB
ReStructuredText

=======
IoT box
=======
To start using an IoT box:
#. Connect your :doc:`devices <devices>` to the IoT box.
#. :ref:`Connect the IoT box to the network <iot/iot_box/network>`.
#. :doc:`Connect the IoT box to your Odoo database <connect>`.
.. seealso::
- `Video: How to Set Up and Use the Odoo IoT Box: A Beginner's Guide <https://www.youtube.com/watch?v=w2_Dcm3r_7o&ab_channel=Odoo>`_
- :doc:`iot_advanced/troubleshooting`
.. _iot/iot_box/network:
Network connection
==================
The IoT box can be connected to the network via :ref:`Ethernet <iot/iot_box/network-ethernet>` or
:ref:`Wi-Fi <iot/iot_box/network-wifi>`.
.. note::
It is recommended to connect the IoT box to the same network as the :doc:`devices <devices>`
connecting to it.
.. important::
The IoT box should only be accessible on the local network and must not be reachable from
external networks.
.. _iot/iot_box/network-ethernet:
Ethernet
--------
Plug the Ethernet cable into the IoT box's Ethernet port and an available port on your router, then
connect the IoT box to a power source.
.. _iot/iot_box/network-wifi:
Wi-Fi
-----
Make sure no Ethernet cable is connected to the IoT box and follow these steps:
#. Connect the IoT box to a power source and wait a few minutes for it to power on.
#. Access your computer's Wi-Fi settings and select the IoT box's network. The network name is in
the format `IoTBox-xxxxxxxxxxxx` (where `xxxxxxxxxxxx` is a unique identifier).
#. Connect to the IoT box's Wi-Fi network and sign into it; your browser should automatically
open and redirect to the :ref:`IoT box's homepage <iot/iot-box/homepage>`.
.. note::
Depending on your operating system, the browser might not open and redirect to the IoT box's
homepage. In this case, open your browser manually and navigate to `http://10.11.12.1`
or any URL starting with **http** (e.g., `http://odoo.com`).
#. On the IoT box's homepage, click :guilabel:`Configure` next to the :guilabel:`Internet Status`
section.
.. image:: iot_box/iot-wifi.png
:scale: 75%
:alt: IoT box's WiFi hotspot
#. Wait a few minutes for the available networks to be scanned, select the network, enter the
Wi-Fi's password, and click :guilabel:`Connect`.
.. note::
Once connected to the Wi-Fi network, the IoT box stops emitting its Wi-Fi signal, and the
computer should automatically reconnect to its original network. If it does not, reconnect to it
manually.
.. tip::
If the IoT box is connected to an :doc:`external monitor <devices/screen>`, you can also scan the
first QR code displayed on the screen to connect to the network, then scan the second QR code to
access the IoT box's :ref:`homepage <iot/iot-box/homepage>`. On the homepage, click
:guilabel:`Configure` in the :guilabel:`Internet Status` section, select the relevant Wi-Fi
network, enter the password, and click :guilabel:`Connect`.
.. _iot/iot-box/led-status:
LED status
==========
The IoT box features two LEDs, located to the right of the SD card slot, which show its status and
help with troubleshooting when no display is connected. The LEDs can be interpreted as follows:
- **Red LED lit**: The IoT box has no Internet connection. Ensure the Ethernet cable is properly
connected or :ref:`connect the IoT box via Wi-Fi <iot/iot_box/network-wifi>`.
- **Green LED flashing**: The IoT box is awaiting :doc:`connection to a database <connect>`.
- **Green LED constantly lit**: The IoT box is connected to a database; no further action is
required.
.. _iot/iot-box/homepage:
IoT box homepage
================
To access the IoT box's homepage, open a web browser **on the same network as the IoT box** and
navigate to the IoT box's IP address.
.. image:: iot_box/iot-homepage.png
:scale: 75%
:alt: IoT box's homepage
The IoT box's IP address can be retrieved by:
- connecting the IoT box to an :doc:`external monitor <devices/screen>`: the IP address is displayed
on the screen.
.. image:: iot_box/iot-status-display.png
:scale: 75%
:alt: Status display with IoT box's IP address
- connecting the IoT box to a `supported receipt or label printer <https://www.odoo.com/app/iot-hardware>`_
with a USB cable: the IP address is automatically printed.
- accessing the administrator interface of the router to which the IoT box is connected or using
third-party software to scan the network.
.. tip::
If the IoT box is connected to an external monitor or a printer, its homepage can also be
accessed by scanning the displayed or printed QR code with a device connected to the same
network as the IoT box.
Once the IoT box is :doc:`connected to the Odoo database <connect>`, its homepage can be accessed
from the IoT app: click the relevant IoT box's card, then click :guilabel:`Homepage`.
.. _iot/iot-box/restart:
IoT box restart
===============
To manually restart the IoT box, access its :ref:`homepage <iot/iot-box/homepage>`, then click the
:icon:`fa-power-off` :guilabel:`(power off)` button in the top-right corner.
.. tip::
You can also fully reboot the IoT box by unplugging and plugging it back in.