[NEW]IoT- Windows IoT doc

Author: tiku-odoo

content/applications/productivity/iot/config.rst

@@ -13,3 +13,4 @@ Configuration
    config/https_certificate_iot
    config/flash_sdcard
    config/troubleshooting
+   config/windows_iot

content/applications/productivity/iot/config/windows_iot.rst

@@ -0,0 +1,181 @@
+=======================================================
+Connecting the Windows IoT software to an Odoo database
+=======================================================
+
+A Virtual IoT box is a computer program that needs to be downloaded and installed on a Windows
+computer. This requires a Windows operating system with an Odoo 16 or later database.
+
+The Windows virtual :abbr:`IoT (Internet of Things)` box works the same way as a physical :abbr:`IoT
+(Internet of Things)` box, with the ability to run most of the same devices. All :abbr:`POS (Point
+of Sale)` devices work with it, such as a scale or printer. Payment terminals will also work, but it
+should be noted that :abbr:`MRP (Material Requirement Planning)` devices are not compatible. *These
+include cameras or measurement tools.*
+
+Pre-requisites
+==============
+
+The following items will be needed to complete the Windows :abbr:`IoT (Internet of Things)`
+installation.
+
+- Odoo 16 database or any version above.
+- :abbr:`IoT (Internet of Things)` compatible devices (except those mentioned above). Refer to:
+  `Odoo's compatible IoT devices <https://www.odoo.com/app/iot-hardware>`_.
+- Device drivers for Windows.
+
+  .. note::
+     Odoo recommends using an updated, recent version of Windows as some older operating systems can
+     cause the Windows virtual :abbr:`IoT (Internet of Things)` to not work.
+
+- Windows computer (laptop, desktop, server).
+- Odoo :abbr:`IoT (Internet of Things)` subscription. Refer to: :ref:`iot/iot-eligibility`.
+
+Connect the Windows virtual Iot box to an Odoo database
+=======================================================
+
+The Windows virtual IoT box is simple to setup in just a few easy steps. Follow this process when
+installing the Windows virtual IoT software for the first time.
+
+Download and initial installation
+---------------------------------
+
+To begin the installation, navigate to the Odoo 16 or higher installation package for Enterprise or
+Community Windows at `Odoo's download page <https://odoo.com/download>`_. Next, install and setup
+the Odoo :file:`.exe` file. After the instructions screen, click :guilabel:`Next` to start the
+installation and agree to the :abbr:`TOS (Terms of Service)`.
+
+During the next step of the installation, select :guilabel:`Odoo IoT` from the :guilabel:`Select the
+type of install` dropdown.
+
+.. example::
+   For reference, the following should be installed:
+
+   - **Odoo server**
+   - **Odoo IoT**
+   - **Nginx WebServer**
+   - **Ghostscript interpreter**
+
+Ensure there is enough space on the computer for the installation and click :guilabel:`Next`.
+
+Setting the destination and completing the installation
+-------------------------------------------------------
+
+To complete the installation, select the :guilabel:`Destination Folder`. Choosing ``C:\odoo`` as the
+install location will allow for the Nginx server to start. Click :guilabel:`Install`. If the folder
+doesn't exist, then create it. Otherwise the installation files will be spread throughout the hard
+drive. Allow the installation to occur. This may take a few minutes. Click :guilabel:`Next` to
+continue.
+
+.. warning::
+   Odoo's Windows virtual IoT software shouldn't be installed inside any of the Window's User's
+   directories. Doing so won't allow for Nginx to initialize.
+
+Ensure that the :guilabel:`Start Odoo` box is checked and click :guilabel:`Finish`. After
+installation, the Odoo server will run and automatically open `http://localhost:8069` on your web
+browser. The webpage should display the :abbr:`IoT (Internet of Things)` *box home page*.
+
+.. seealso::
+   A restart of the Windows IoT program may be necessary should the web browser not display
+   anything. :ref:`iot/restart_windows_iot`
+
+Connecting devices
+------------------
+
+Next, connect the :abbr:`IoT (Internet of Things)` devices to the Windows computer. Windows should
+automatically detect the device because the driver is pre-installed on the computer. If not, search
+for and install the Windows driver for the device.
+
+Following connecting devices to the computer, refresh the :abbr:`IoT (Internet of Things)` *box home
+page* and verify the device is seen. If not, reload the handlers through the :abbr:`IoT (Internet of
+Things)` *box home page*.
+
+Finally, connect Windows :abbr:`IoT (Internet of Things)` to a database using existing instructions
+(manually using the Token).
+
+.. seealso::
+   :doc:`/applications/productivity/iot/config/connect`
+
+Now the installation is complete, the devices connected to :abbr:`IoT (Internet of Things)` can be
+used to complete processes/actions.
+
+Troubleshooting
+===============
+
+.. _iot/restart_windows_iot:
+
+Restart Windows IoT box
+-----------------------
+
+In some instances a manual restart of the physical :abbr:`IoT (Internet of Things)` box can resolve
+the issue of an :abbr:`IoT (Internet of Things)` box not showing up on the database. For the Windows
+virtual :abbr:`IoT (Internet of Things)` box a manual restart of the Odoo server can resolve
+database connection issues.
+
+To restart the virtual Windows IoT server:
+
+#. Type `Services` into the :guilabel:`Search Bar`.
+#. Select the :menuselection:`Services` App and scroll down to the :guilabel:`Odoo` service.
+#. Right click on :guilabel:`Odoo` and select :guilabel:`Start` or :guilabel:`Restart`. This action
+   will manually restart the Odoo IoT server.
+
+Firewalls
+---------
+
+Firewalls keep devices safe and secure. Sometimes they can block connections that should be made
+though. The Windows virtual :abbr:`IoT (Internet of Things)` box software may not be reachable to
+the :abbr:`LAN (Local Area Network)` due to a firewall preventing the connection. Consult your local
+IT support to make exceptions (network discovery) in the :abbr:`OS (Operating System)` or firewall
+program. Windows has their own firewall as do other virus protection programs.
+
+.. example::
+   A client might encounter a time when they are able to reach the homepage of the :abbr:`IoT
+   (Internet of Things)` box, yet they cannot access it from another computer/mobile device/tablet
+   on the same network.
+
+Making an exception on Windows Defender
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+It's possible to allow other devices to access the Windows virtual :abbr:`IoT (Internet of Things)`
+box while keeping the firewall on. This is done by creating a rule on *Windows Defender* and
+allowing communication through port `8069`. The following process describes the steps to take in
+order to make this exception.
+
+Navigating to Windows Defender to create the rule
+*************************************************
+
+First, open the *Windows Firewall* by navigating to the :menuselection:`Start Menu` and typing in
+`Firewall`. Then, open the :menuselection:`Windows Defender Firewall` program. In the left-hand
+menu, navigate to :guilabel:`Advanced Settings`.
+
+Once :guilabel:`Advanced Settings` have been selected, click :guilabel:`Inbound Rules` in the
+left-hand menu. Then, in the right-hand menu column (under :guilabel:`Inbound Rules`), click on
+:guilabel:`New Rule` to create a new rule.
+
+Configure new rule
+******************
+
+On the :menuselection:`Rule Type` screen, select :guilabel:`Port`. Then click :guilabel:`Next`. From
+the :menuselection:`Protocol and Ports` page leave the rule application to :guilabel:`TCP`. Then,
+select :guilabel:`Specific Local Ports` for the :guilabel:`ports` option. In the text box, type in
+`8069`. Finally click :guilabel:`Next` to continue to the next step.
+
+On the :menuselection:`Actions` page, select :guilabel:`Allow the connection` and click
+:guilabel:`Next`. The following page on the :menuselection:`Rule Configuration` wizard is the
+:menuselection:`Profile` page. On this page, select whichever connection type applies to the network
+the Windows machine is operating on. Ideally, select :guilabel:`Private` only connections. The
+*Private* connection type is the most secure connection while allowing the selected port to
+communicate. Click :guilabel:`Next` to continue.
+
+Finally, assign a new, unique name to the rule. For example, this name can be `Odoo`. Optionally,
+add a brief description in the :guilabel:`Description` field. Click :guilabel:`Finish` to complete
+the *rule configuration*. Now, the new rule is active and devices can connect to the Windows virtual
+:abbr:`IoT (Internet of Things)` box.
+
+Uninstalling Windows IoT
+------------------------
+
+Uninstalling the Windows virtual :abbr:`IoT (Internet of Things)` box is done through the Windows
+program manager. Using any Windows version, search for `program`. Then, select :guilabel:`Add or
+Remove Programs` located in the control panel. Search for `Odoo` and click the :guilabel:`three dot
+menu` to uninstall.
+
+Confirm the un-installation and follow the steps to uninstall through the Odoo uninstall guide.