[ADD] Productivity: IoT - Windows IoT doc #4025
Conversation
|
Quick item on the CI check @tiku-odoo https://runbot.odoo.com/runbot/build/27793011 |
tiku-odoo
force-pushed
the
16.0-IOT-Windows-Virtual-IoT
branch
2 times, most recently
from
105ca6b to
db680bc
Compare
|
@StraubCreative I corrected this build error. Thanks for catching. |
hojo-odoo
left a comment
hojo-odoo
left a comment
There was a problem hiding this comment.
Hey Tim,
Good job on this.
Thanks,
hojo
| Uninstalling the Windows virtual IoT is done through the Windows program manager. Search in any | ||
| Windows version for ''program''. Select :guilabel:`Add or Remove Programs` located in the control | ||
| panel. Search for ``Odoo`` and click the :guilabel:`three dot menu` to uninstall. |
There was a problem hiding this comment.
Rephrase; also, just searching "Odoo" may bring up multiple programs, so you should specify the exact name of the program being uninstalled
| Uninstalling the Windows virtual IoT is done through the Windows program manager. Search in any | |
| Windows version for ''program''. Select :guilabel:`Add or Remove Programs` located in the control | |
| panel. Search for ``Odoo`` and click the :guilabel:`three dot menu` to uninstall. | |
| Uninstalling the Windows virtual IoT box is done through the Windows program manager. From the | |
| :guilabel:`Start` menu, search for ''program''. Select :guilabel:`Add or Remove Programs` . In the window that appears, search for ``Odoo``, click the :guilabel:`three dot menu`, then select :guilabel:`Uninstall`. |
There was a problem hiding this comment.
Odoo is the name of the program that should be uninstalled. I tested this a couple times. What did you encounter?
There was a problem hiding this comment.
Did you encounter multiple Odoo programs? The uninstall should be from Odoo and there are other programs that will be uninstalled.
tiku-odoo
force-pushed
the
16.0-IOT-Windows-Virtual-IoT
branch
from
db680bc to
cb7032e
Compare
|
@lse-odoo Can you review this doc when you have a moment on the Windows Virtual IoT? Thanks 👍 |
| @@ -0,0 +1,112 @@ | |||
| =============================================================== | |||
| Use Windows IoT software to connect devices to an Odoo database | |||
There was a problem hiding this comment.
personally, not a huge fan of this title, I don't think it represent well the content.
What do you think of:
"IoT box for Windows computer" or "Odoo Windows IoT"
There was a problem hiding this comment.
I originally had something like you mentioned and the final editor recommended I change it.
| :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. |
There was a problem hiding this comment.
I don't really know what are the devices supported and not, but it might be worth to consider having a dedicated page/section with a table of compatibility of devices per "iot boxes", what do you think ?
There was a problem hiding this comment.
This is a good idea, except I don't have the ability to do any testing (lack of devices), this information would need to come from the experts in SF and BE. Is that something that you can do? CC: @dara-odoo
Thanks,
Tim
There was a problem hiding this comment.
Hey @tiku-odoo ! I can perform some testing to see which devices are compatible with the virtual IoT Software! The only things I cannot test are the following:
- Weighing scale (our scale in SF doesn't work, even when connected to the traditional IoT Box.
- Any MRP tools like measurement tools; we don't have that here.
Someone from BE should be able to test the rest (assuming there is at least one Windows machine over there). I'll let you know what's compatible through here in a few days!
There was a problem hiding this comment.
Noted, thanks, that would be great. We can put this in the devices.rst file when it's complete.
CC: @lse-odoo
There was a problem hiding this comment.
Hey @tiku-odoo !
Apologies for the delay. I did some testing and I can confirm that the following devices are compatible with both Physical and Virtual IoT based on the devices we have in the SF office. For devices not tested, we would need BE's input. (also I am not too sure how to submit this in the devices.rst file):
SCREEN
-
HDMI device:
-
Physical IoT: Compatible.
-
Virtual IoT: Not Working/Not Compatible. Device connected via HDMI is not being detected in the Virtual IoT Box's configuration page.
-
Integrated display (Laptop):
-
Physical IoT: Compatible
-
Virtual IoT: Not Working/Not Compatible. See above reason.
MEASUREMENT TOOL
Not tested in SF office; Does not have required device to test this on Physical or Virtual IoT.
CAMERA
- Logitech (as suggested on our IoT Devices list): Not tested in the SF office; Does not have required device to test this on Physical or Virtual IoT.
- Non-Logitech:
- Physical IoT: Compatible via USB only.
- Virtual IoT: Not Working/Not Compatible. Camera connected via USB is not being detected in the Virtual IoT Box's configuration page.
FOOTSWITCH
Not tested in the SF office; Does not have required device to test this on Physical or Virtual IoT.
PRINTERS
Receipt Printers
-
Epson Printers (with ESC/POS protocol):
-
Physical IoT: Compatible; either connected via USB or via Network
-
Virtual IoT: Compatible; either connected via USB or via Network. You would need to install the required drivers for the Epson printer to work on Virtual IoT.
-
Star-compatible Printers (with STAR protocol): Not tested in the SF office; Does not have required device to test this on Physical or Virtual IoT.
Receipt Printers > Cash Registers
- Epson Compatible: Can only be connected to an Epson printer using the serial/network cable. See "Epson Printers" for compatibility.
- USB: Not Compatible.
Desktop Printers
- Brother Inkjet/Laserjet:
- Physical IoT: Compatible; either connected via USB or via Network. Must be detectible from the integrated CUPS server on the Physical IoT.
- Virtual IoT: Compatible; either connected via USB or via Network. You would need to install the required drivers for the Desktop printer to work on Virtual IoT (no integrated CUPS server to be auto-detected).
Label Printers
- Zebra Printers (with ZPL protocol):
- Physical IoT: Compatible via USB only.
- Virtual IoT: Not Working/Not Compatible. Windows drivers allow the printer to be seen on the computer and on the virtual IoT Software, but is not able to utilized when a report is assigned to the printer. Receives an "IoT Box is disconnected" error.
SCALE
Not tested in the SF office; Current scale at SF office does not connect to IoT Box properly, even if it's a suggested scale. Cannot test on Physical or Virtual IoT.
tiku-odoo
force-pushed
the
16.0-IOT-Windows-Virtual-IoT
branch
from
cb7032e to
91e74ed
Compare
|
@samueljlieber This doc is ready for your technical review when you have a moment. Thanks for your review on this. Tim |
| Firewalls | ||
| --------- | ||
|
|
||
| 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 well as other virus protection do too. |
There was a problem hiding this comment.
From a support point of view, I am a bit afraid that this part will be overlooked by customers as it is "too technical".
Don't you think it would be better to use an actual example ? Like:
"I can see the IoT box homepage from the Windows virtual computer, but can not access it from other computers/mobiles/tablet in the same network"
speaking about LAN will confuse most of the customers and we (the support) will likely lose time redirecting then to this part of the documentation. It might also be a good occasion to add a .seealso to
https://www.odoo.com/documentation/16.0/applications/productivity/iot/config/troubleshooting.html#my-iot-box-is-connected-to-my-database-but-cannot-be-reached
What do you think ?
There was a problem hiding this comment.
I've added this example into the doc. Thanks for suggesting @lse-odoo
tiku-odoo
force-pushed
the
16.0-IOT-Windows-Virtual-IoT
branch
from
91e74ed to
83cf95b
Compare
samueljlieber
left a comment
samueljlieber
left a comment
There was a problem hiding this comment.
Hi @tiku-odoo 👋 I've made some technical changes on windows_iot.rst, mostly very small formatting changes. Please review the changes below and let me know if you approve and I will tag this PR for final review. I will push these changes up in a commit after this review.
There was a problem hiding this comment.
| #. Install and setup the Odoo .exe file. | |
| #. Install and setup the Odoo :file:`.exe` file. |
There was a problem hiding this comment.
| After the instructions screen click :guilabel:`Next` to start the installation. Agree to the | |
| After the :guilabel:`Instructions` screen click :guilabel:`Next` to start the installation. Agree | |
| to the :abbr:`TOS (Terms of Service)`. |
There was a problem hiding this comment.
| :doc:`connect` | |
| :doc:`/applications/productivity/iot/config/connect` |
There was a problem hiding this comment.
| #. Type "Services" into the :guilabel:`Search Bar` | |
| #. Type `Services` into the :guilabel:`Search Bar` |
There was a problem hiding this comment.
| program manager. Search in any Windows version for ''program''. Select :guilabel:`Add or Remove | |
| Programs` located in the control panel. Search for ``Odoo`` and click the :guilabel:`three dot menu` | |
| to uninstall. | |
| program manager. Search in any Windows version for `program`. Select :menuselection:`Add or Remove | |
| Programs` located in the :guilabel:`Control Panel`. Search for `Odoo` and click the :guilabel:`⋮ | |
| (three dot menu)` to uninstall. |
samueljlieber
force-pushed
the
16.0-IOT-Windows-Virtual-IoT
branch
from
83cf95b to
bfb1de1
Compare
samueljlieber
changed the title
|
Implemented technical changes and corrected commit title in bfb1de1 |
|
@samueljlieber The changes you made are good to push to Final review. Thanks for your technical review. Tim 👍 |
|
Hi @StraubCreative this PR is ready for your final review 🙂 |
StraubCreative
left a comment
StraubCreative
left a comment
There was a problem hiding this comment.
@tiku-odoo please fix the 100th character line break issues here and reconsider your lists approach to writing thorough documentation.
Lists are ideally used for form walkthroughs or for sets of quick, successive instructions that must be done in order; lists do not suffice as the main body content.
Tag me again when it's ready for another look, thanks!
cc: @hojo-odoo
tiku-odoo
force-pushed
the
16.0-IOT-Windows-Virtual-IoT
branch
from
bfb1de1 to
0270ac2
Compare
|
@samueljlieber Can you review this doc when you have a moment? Thanks, Tim |
tiku-odoo
force-pushed
the
16.0-IOT-Windows-Virtual-IoT
branch
2 times, most recently
from
4f1e7c7 to
da71d1e
Compare
brse-odoo
left a comment
brse-odoo
left a comment
There was a problem hiding this comment.
Hey @tiku-odoo, I've just finished my review of the new section. Great job! All my suggestions were pretty minor grammatical stuff, but I think a sentence or two at the start of each section to better explain concepts would be helpful.
Another thing that I didn't comment but might be worth considering -- can the H5 headings you use be H4s, instead? Only if it makes sense (I think H5 is really small). Otherwise it's not a big deal. Let me know if you have any questions!
There was a problem hiding this comment.
Why only private connections? A quick sentence to explain could help
There was a problem hiding this comment.
| program manager. Search in any Windows version for ''program''. Select :guilabel:`Add or Remove | |
| program manager. Using any Windows version, search for for ''program''. Then, select :guilabel:`Add or Remove |
tiku-odoo
force-pushed
the
16.0-IOT-Windows-Virtual-IoT
branch
from
da71d1e to
2e45d89
Compare
|
@samueljlieber This doc is ready for your technical review. |
samueljlieber
left a comment
samueljlieber
left a comment
There was a problem hiding this comment.
Hi @tiku-odoo I have a handful of technical changes for this PR, please see them below and then tag me again for another review once these edits have been made. Thank you! 🙂
Let me know if you have any questions!
|
|
||
| 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* |
There was a problem hiding this comment.
Missing period and can remove italic formatting
| browser. The webpage should display the :abbr:`IoT (Internet of Things)` *box home page* | |
| browser. The webpage should display the :abbr:`IoT (Internet of Things)` box home page. |
There was a problem hiding this comment.
@StraubCreative This is the label of the page, I originally didn't have this italicized, but the expert pointed this out. I'm okay with either way, not a big deal in my opinion. We will have to implement in the IoT bundle PR if there are changes though (PR #3673). I can double check the label as well on this.
tiku-odoo
force-pushed
the
16.0-IOT-Windows-Virtual-IoT
branch
from
2e45d89 to
c64a5c9
Compare
|
@samueljlieber This doc is ready for another review. Thanks for you help on this doc! 👍 Tim |
samueljlieber
left a comment
samueljlieber
left a comment
There was a problem hiding this comment.
Hi @tiku-odoo this PR is looking really great - nice job! I just found one missing period that remained. Please make this correction before tagging for final review, other than that I feel this PR is ready for final review. Thanks Tim! 🙂
tiku-odoo
force-pushed
the
16.0-IOT-Windows-Virtual-IoT
branch
from
c64a5c9 to
ed42624
Compare
|
@StraubCreative This doc is ready for your review. Thanks! 👍 |
|
@StraubCreative When you have a moment can you review this doc? It is ready for final review! Thanks. |
There was a problem hiding this comment.
Hi @tiku-odoo
Pretty fun and straight-forward doc. I feel like I could figure this out easily with what you have here 🙂
I have a few suggestions below, however, these are all for your consideration and are entirely optional. It might be better to merge right away and improve later since this is a brand new doc...
With whatever you choose (making the suggested changes in another commit or just merging right away), just issue the merge command ( [at]robodoo r+ ) whenever you're ready 🚀
@robodoo delegate+
tiku-odoo
force-pushed
the
16.0-IOT-Windows-Virtual-IoT
branch
from
ed42624 to
69e2e38
Compare
|
@robodoo delegate+ |
|
I'm sorry, @tiku-odoo: you can't delegate+. |
|
@robodoo r+ |
|
I'm sorry, @tiku-odoo: you can't review+. |
|
@robodoo r+ |
8 participants
Doc Task: https://www.odoo.com/web#id=3057207&menu_id=4720&cids=3&action=333&active_id=3835&model=project.task&view_type=form
@odoo/us-doc-review This doc is ready for your review when you have a moment.
Thanks in advance for your help on this.