mirror of
https://github.com/OCA/web.git
synced 2025-02-22 13:21:25 +02:00
[ADD] web_widget_remote_measure: New module
TT38745
This commit is contained in:
David
130
web_widget_remote_measure/README.rst
Normal file
130
web_widget_remote_measure/README.rst
Normal file
@@ -0,0 +1,130 @@
|
||||
============================
|
||||
Remote Measure Devices Input
|
||||
============================
|
||||
|
||||
.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
||||
!! This file is generated by oca-gen-addon-readme !!
|
||||
!! changes will be overwritten. !!
|
||||
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
||||
|
||||
.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
|
||||
:target: https://odoo-community.org/page/development-status
|
||||
:alt: Beta
|
||||
.. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png
|
||||
:target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
|
||||
:alt: License: AGPL-3
|
||||
.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fweb-lightgray.png?logo=github
|
||||
:target: https://github.com/OCA/web/tree/15.0/web_widget_remote_measure
|
||||
:alt: OCA/web
|
||||
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
|
||||
:target: https://translation.odoo-community.org/projects/web-15-0/web-15-0-web_widget_remote_measure
|
||||
:alt: Translate me on Weblate
|
||||
.. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png
|
||||
:target: https://runbot.odoo-community.org/runbot/162/15.0
|
||||
:alt: Try me on Runbot
|
||||
|
||||
|badge1| |badge2| |badge3| |badge4| |badge5|
|
||||
|
||||
This module allows to input data from remote devices in your network. Currently, only
|
||||
websockets devices are supported, but it can be extended for any protocol like
|
||||
Webservices.
|
||||
|
||||
Other modules can extend this one in order to use the widget.
|
||||
|
||||
**Table of contents**
|
||||
|
||||
.. contents::
|
||||
:local:
|
||||
|
||||
Configuration
|
||||
=============
|
||||
|
||||
To configure your remote devices:
|
||||
|
||||
#. Go to *Settings > Technical > Devices > Remote devices*
|
||||
#. Create a new one configuring the required info.
|
||||
#. If the devices has an special port, set it up in the host data: e.g.: 10.1.1.2:3210
|
||||
|
||||
Usage
|
||||
=====
|
||||
|
||||
The remote device has to be in the users network so their web clients can reach them.
|
||||
|
||||
In order to test a device you can:
|
||||
|
||||
#. Go to *Settings > Technical > Devices > Remote devices*
|
||||
#. In the Kanban view you'll wich devices can be reached as they'll have a green dot in
|
||||
their card.
|
||||
#. Go to one of those and click *Edit*.
|
||||
#. You can start measuring from the remote device in the *Test measure* field.
|
||||
|
||||
On the technical side, you can use the widget in your own `Float``. You'll need to
|
||||
provide an uom field so records that aren't in that UoM don't measure from the device.
|
||||
|
||||
.. code:: xml
|
||||
|
||||
<field name="float_field" widget="remote_measure" options="{'remote_device_field': 'measure_device_id', 'uom_field': 'uom_id'}" />
|
||||
|
||||
Known issues / Roadmap
|
||||
======================
|
||||
|
||||
Current support:
|
||||
|
||||
- Websockets connection
|
||||
- F501 protocol on continuous message stream.
|
||||
|
||||
But this is a commonground to add:
|
||||
|
||||
- Other connection interfaces like Webservices APIs
|
||||
- Other device protocols.
|
||||
- Active device controls, la Tare, resets, etc.
|
||||
|
||||
Bug Tracker
|
||||
===========
|
||||
|
||||
Bugs are tracked on `GitHub Issues <https://github.com/OCA/web/issues>`_.
|
||||
In case of trouble, please check there if your issue has already been reported.
|
||||
If you spotted it first, help us smashing it by providing a detailed and welcomed
|
||||
`feedback <https://github.com/OCA/web/issues/new?body=module:%20web_widget_remote_measure%0Aversion:%2015.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
|
||||
|
||||
Do not contact contributors directly about support or help with technical issues.
|
||||
|
||||
Credits
|
||||
=======
|
||||
|
||||
Authors
|
||||
~~~~~~~
|
||||
|
||||
* Tecnativa
|
||||
|
||||
Contributors
|
||||
~~~~~~~~~~~~
|
||||
|
||||
* `Tecnativa <https://www.tecnativa.com>`_:
|
||||
|
||||
* David Vidal
|
||||
|
||||
Maintainers
|
||||
~~~~~~~~~~~
|
||||
|
||||
This module is maintained by the OCA.
|
||||
|
||||
.. image:: https://odoo-community.org/logo.png
|
||||
:alt: Odoo Community Association
|
||||
:target: https://odoo-community.org
|
||||
|
||||
OCA, or the Odoo Community Association, is a nonprofit organization whose
|
||||
mission is to support the collaborative development of Odoo features and
|
||||
promote its widespread use.
|
||||
|
||||
.. |maintainer-chienandalu| image:: https://github.com/chienandalu.png?size=40px
|
||||
:target: https://github.com/chienandalu
|
||||
:alt: chienandalu
|
||||
|
||||
Current `maintainer <https://odoo-community.org/page/maintainer-role>`__:
|
||||
|
||||
|maintainer-chienandalu|
|
||||
|
||||
This module is part of the `OCA/web <https://github.com/OCA/web/tree/15.0/web_widget_remote_measure>`_ project on GitHub.
|
||||
|
||||
You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
|
||||
Reference in New Issue
Block a user