Skip to content

Commit 91e74ed

Browse files
committed
[NEW]IoT- Windows IoT doc
1 parent b6b9de7 commit 91e74ed

File tree

2 files changed

+135
-0
lines changed

2 files changed

+135
-0
lines changed

content/applications/productivity/iot/config.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,3 +13,4 @@ Configuration
1313
config/https_certificate_iot
1414
config/flash_sdcard
1515
config/troubleshooting
16+
config/windows_iot
Lines changed: 134 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,134 @@
1+
=======================================================
2+
Connecting the Windows IoT software to an Odoo database
3+
=======================================================
4+
5+
A Virtual IoT box is a computer program that needs to be downloaded and installed on a Windows
6+
computer. This requires a Windows operating system with an Odoo 16 or later database.
7+
8+
The Windows Virtual :abbr:`IoT (Internet of Things)` box works the same way as a physical
9+
:abbr:`IoT (Internet of Things)` box, with the ability to run most of the same devices. All
10+
:abbr:`POS (Point of Sale)` devices work with it, such as a scale or printer. Payment terminals will
11+
also work, but it should be noted that :abbr:`MRP (Material Requirement Planning)` devices are not
12+
compatible. *These include cameras or measurement tools.*
13+
14+
Pre-requisites
15+
==============
16+
17+
- Odoo 16 database or any version above
18+
- :abbr:`IoT (Internet of Things)` compatible devices (except those mentioned above)
19+
20+
.. seealso::
21+
`Odoo's compatible IoT devices <https://www.odoo.com/app/iot-hardware>`_
22+
23+
- Device drivers for Windows
24+
25+
.. note::
26+
Odoo recommends using an updated, recent version of Windows as some older operating systems can
27+
cause the Windows virtual :abbr:`IoT (Internet of Things)` to not work.
28+
29+
- Windows computer (laptop, desktop, server)
30+
- Odoo IoT subscription
31+
32+
.. seealso::
33+
:ref:`iot/iot-eligibility`
34+
35+
Connect the Windows virtual Iot box to an Odoo database
36+
=======================================================
37+
38+
#. Navigate to the Odoo 16 or higher installation package for Enterprise/Community Windows at
39+
`Odoo's Download Page <https://odoo.com/download>`_.
40+
41+
#. Install and setup the Odoo .exe file.
42+
43+
After the instructions screen click :guilabel:`Next` to start the installation. Agree to the
44+
:abbr:`TOS (Terms of Service)`.
45+
46+
#. During the next step of the installation, select :guilabel:`Odoo IoT` from the :guilabel:`Select
47+
the type of install` dropdown.
48+
49+
For reference, the following should be installed:
50+
51+
- **Odoo server**
52+
- **Odoo IoT**
53+
- **Nginx WebServer**
54+
- **Ghostscript interpreter**
55+
56+
57+
Ensure there is enough space on the computer for the installation and click :guilabel:`Next`.
58+
59+
#. Select the :guilabel:`Destination Folder`.
60+
61+
.. warning::
62+
Odoo's Windows virtual IoT software shouldn't be installed inside any of the Window's User's
63+
directories. Doing so won't allow for Nginx to initialize.
64+
65+
Choosing ``C:\odoo`` as the install location will allow for the Nginx server to start. Click
66+
:guilabel:`Install`. If the folder doesn't exist, then create it. Otherwise the installation
67+
files will be spread throughout the hard drive.
68+
69+
#. Allow the installation to occur. This may take a few minutes. Click :guilabel:`Next` to continue.
70+
71+
#. Ensure that the :guilabel:`Start Odoo` box is checked and click :guilabel:`Finish`.
72+
73+
#. After installation, the Odoo server will run and automatically open ``localhost:8069`` on your
74+
web browser. The webpage should display the :abbr:`IoT (Internet of Things)` Box configuration
75+
page.
76+
77+
.. seealso::
78+
A restart of the Windows IoT program may be necessary should the web browser not display
79+
anything. :ref:`restart_windows_iot`
80+
81+
#. Connect :abbr:`IoT (Internet of Things)` devices to the Windows computer.
82+
83+
#. Windows should automatically detect the device because the driver is pre-installed on
84+
the computer. If not, search for and install the Windows driver for the device.
85+
86+
#. Refresh the :abbr:`IoT (Internet of Things)` Box Configuration Page and verify the device is
87+
seen on the configuration page. If not, reload the handlers through the configuration page.
88+
89+
#. Connect Windows :abbr:`IoT (Internet of Things)` to a database using existing instructions
90+
(manually using the Token).
91+
92+
.. seealso::
93+
:doc:`connect`
94+
95+
#. Use the devices connected to :abbr:`IoT (Internet of Things)` as you normally would.
96+
97+
98+
Troubleshooting
99+
===============
100+
101+
.. _restart_windows_iot:
102+
103+
Restart Windows IOT box
104+
-----------------------
105+
106+
In some instances a manual restart of the physical :abbr:`IoT (Internet of Things)` box can resolve
107+
the issue of an :abbr:`IoT (Internet of Things)` box not showing up on the database. For the Windows
108+
virtual :abbr:`IoT (Internet of Things)` box a manual restart of the Odoo server can resolve
109+
database connection issues.
110+
111+
To restart the virtual Windows IoT server:
112+
113+
#. Type "Services" into the :guilabel:`Search Bar`
114+
#. Select the :menuselection:`Services` App and scroll down to the :guilabel:`Odoo` Service.
115+
#. Right click on :guilabel:`Odoo` and select :guilabel:`Start` or :guilabel:`Restart`. This action
116+
will manually restart the Odoo IoT server.
117+
118+
Firewalls
119+
---------
120+
121+
The Windows virtual :abbr:`IoT (Internet of Things)` box software may not be reachable to the
122+
:abbr:`LAN (Local Area Network)` due to a firewall preventing the connection. Consult your local IT
123+
support to make exceptions (network discovery) in the :abbr:`OS (Operating System)` or firewall
124+
program. Windows has their own firewall as well as other virus protection do too.
125+
126+
Uninstalling Windows IoT
127+
------------------------
128+
129+
Uninstalling the Windows virtual :abbr:`IoT (Internet of Things)` box is done through the Windows
130+
program manager. Search in any Windows version for ''program''. Select :guilabel:`Add or Remove
131+
Programs` located in the control panel. Search for ``Odoo`` and click the :guilabel:`three dot menu`
132+
to uninstall.
133+
134+
Confirm the un-installation and follow the steps to uninstall through the Odoo uninstall guide.

0 commit comments

Comments
 (0)