Skip to content

Commit 105ca6b

Browse files
committed
[IMP]IoT- Windows IoT doc
1 parent 0a384a2 commit 105ca6b

File tree

2 files changed

+125
-0
lines changed

2 files changed

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

0 commit comments

Comments
 (0)