e3fee2cf46
Prior to this commit, the Odoo documentation was mainly split between
two repositories: odoo/odoo/doc and odoo/documentation-user. Some bits
of documentation were also hosted elsewhere (e.g., wiki, upgrade, ...).
This was causing several problems among which:
- The theme, config, Makefile, and similar technical resources had to
be duplicated. This resulted in inconsistent layout, features, and
build environments from one documentation to another.
- Some pages did not fit either documentation as they were relevant
for both users and developers. Some were relevant to neither of the
two (e.g., DB management).
- Cross-doc references had to be absolute links and they broke often.
- Merging large image files in the developer documentation would bloat
the odoo/odoo repository. Some contributions had to be lightened to
avoid merging too many images (e.g., Odoo development tutorials).
- Long-time contributors to the user documentation were chilly about
going through the merging process of the developer documentation
because of the runbot, mergebot, `odoo-dev` repository, etc.
- Some contributors would look for the developer documentation in the
`odoo/documentation-user` repository.
- Community issues about the user documentation were submitted on the
`odoo/odoo` repository and vice-versa.
Merging all documentations in one repository will allow us to have one
place, one theme, one work process, and one set of tools (build
environment, ...) for all of the Odoo docs.
As this is a good opportunity to revamp the layout of the documentation,
a brand new theme replaces the old one. It features a new way to
navigate the documentation, centered on the idea of always letting the
reader know what is the context (enclosing section, child pages, page
structure ...) of the page they are reading. The previous theme would
quickly confuse readers as they navigated the documentation and followed
cross-application links.
The chance is also taken to get rid of all the technical dangling parts,
performance issues, and left-overs. Except for some page-specific JS
scripts, the Odoo theme Sphinx extension is re-written from scratch
based on the latest Sphinx release to benefit from the improvements and
ease future contributions.
task-2351938
task-2352371
task-2205684
task-2352544
Closes #945
53 lines
1.7 KiB
ReStructuredText
53 lines
1.7 KiB
ReStructuredText
====================
|
||
Connect a Footswitch
|
||
====================
|
||
|
||
When working, it is always better to have your two hands available.
|
||
Using Odoo’s *IoT Box* and a footswitch will allow it.
|
||
|
||
In fact, you will be able to go from one screen to another by using your
|
||
foot and the footswitch. Really convenient, it can be configured in a
|
||
few steps.
|
||
|
||
Connection
|
||
==========
|
||
|
||
Connecting the footswitch to the *IoT Box* is easy, you just have to
|
||
combine the two by cable.
|
||
|
||
.. note::
|
||
In some cases, a serial to USB adapter may be needed.
|
||
|
||
If your footswitch is a `supported
|
||
one <https://www.odoo.com/page/iot-hardware>`__, there is no need to
|
||
set up anything since it will be automatically detected when connected.
|
||
|
||
.. image:: media/footswitch_01.png
|
||
:align: center
|
||
|
||
If it is not a supported one, you may need to restart the box and
|
||
download your footswitch’s drivers from the box. To do so, go to the
|
||
*IoT Box Home Page* and click on *drivers list*. Then, click on load
|
||
drivers.
|
||
|
||
.. image:: media/footswitch_02.png
|
||
:align: center
|
||
|
||
Link a Footswitch to a Workcenter
|
||
=================================
|
||
|
||
To link the footswitch to an action, it needs to be configured on a
|
||
workcenter. Go to the workcenter you want to use the footswitch in and
|
||
add the device in the *IoT Triggers* tab. Then, you can link it to an
|
||
action and also add a key to trigger it.
|
||
|
||
.. image:: media/footswitch_03.png
|
||
:align: center
|
||
|
||
Note that the one that is first in the list will be chosen. So, the
|
||
order matters! In the picture above, using the footswitch will, for
|
||
example, automatically skip the current part of the process you work on.
|
||
|
||
.. note::
|
||
When you are on the work order screen, a status button indicates if you
|
||
are correctly connected to the footswitch. |