Skip to content

Commit db680bc

Browse files
committed
[IMP]IoT- Windows IoT doc
1 parent 7124542 commit db680bc

File tree

2 files changed

+122
-0
lines changed

2 files changed

+122
-0
lines changed

content/applications/productivity/iot/config.rst

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

0 commit comments

Comments
 (0)