odoo-addon-web-widget-remote-measure 15.0.1.1.0__py3-none-any.whl → 17.0.1.0.0.4__py3-none-any.whl

odoo/addons/web_widget_remote_measure/static/src/remote_measure_field/remote_measure_field.esm.js

@@ -0,0 +1,428 @@
+/** @odoo-module **/
+import {FloatField, floatField} from "@web/views/fields/float/float_field";
+import {
+    onWillDestroy,
+    onWillStart,
+    onWillUnmount,
+    useEffect,
+    useState,
+} from "@odoo/owl";
+import {_t} from "@web/core/l10n/translation";
+import {registry} from "@web/core/registry";
+import {useService} from "@web/core/utils/hooks";
+
+// Animate the measure steps for each measure received.
+export const nextState = {
+    "fa-thermometer-empty": "fa-thermometer-quarter",
+    "fa-thermometer-quarter": "fa-thermometer-half",
+    "fa-thermometer-half": "fa-thermometer-three-quarters",
+    "fa-thermometer-three-quarters": "fa-thermometer-full",
+    "fa-thermometer-full": "fa-thermometer-empty",
+};
+
+export class RemoteMeasureField extends FloatField {
+    static props = {
+        ...FloatField.props,
+        remote_device_field: {type: String, optional: true},
+        uom_field: {type: String, optional: true},
+        default_user_device: {type: Boolean, optional: true},
+        allow_additive_measure: {type: Boolean, optional: true},
+    };
+    static template = "web_widget_remote_measure.RemoteMeasureField";
+
+    setup() {
+        super.setup();
+        this.rpc = useService("rpc");
+        this.orm = useService("orm");
+        this.user = useService("user");
+        this.remote_device_data = {};
+        [this.default_user_device] =
+            (this.props.default_user_device &&
+                this.user.settings.remote_measure_device_id) ||
+            [];
+        // When we're in the own device, we already have the data
+        if (
+            this.props.record.resModel === "remote.measure.device" &&
+            this.props.record.resId
+        ) {
+            this.remote_device_data.id = this.props.record.resId;
+            [this.uom] = this.props.record.data.uom_id;
+        } else if (this.props.remote_device_field) {
+            [this.remote_device_data.id] =
+                this.props.record.data[this.props.remote_device_field];
+        } else if (this.default_user_device) {
+            [this.remote_device_data.id] = this.default_user_device;
+        }
+        if (!this.uom && this.props.uom_field) {
+            [this.uom] = this.props.record.data[this.props.uom_field];
+        }
+        onWillStart(async () => {
+            if (!this.remote_device_data || !this.uom) {
+                return;
+            }
+            [this.uom] = await this.orm.call("uom.uom", "read", [this.uom]);
+            [this.remote_device_data] = await this.orm.call(
+                "remote.measure.device",
+                "read",
+                [this.remote_device_data.id]
+            );
+            this._assigDeviceData();
+        });
+        this.default_ui_state = {
+            stop: true,
+            measuring: false,
+            icon: "fa-thermometer-half",
+            // Additional class for colors and others
+            class: "btn-secondary",
+            input_val: this.value,
+            start_add: false,
+        };
+        this.state = useState({
+            ...this.state,
+            ...this.default_ui_state,
+            additive_measure: false,
+        });
+        // Reset states when we leave the button
+        // TODO: Also halt any reading!
+        useEffect(
+            (readonly) => {
+                if (readonly) {
+                    this.state.stop = true;
+                    this.state.measuring = false;
+                }
+            },
+            () => [this.props.readonly]
+        );
+        useEffect(
+            (value) => {
+                if (value > 0 && this.props.allow_additive_measure) {
+                    this.state.additive_measure = true;
+                }
+            },
+            () => [this.value]
+        );
+        onWillDestroy(() => this._closeSocket());
+        onWillUnmount(() => this._closeSocket());
+    }
+
+    // Private methods
+
+    /**
+     * @private
+     */
+    _assigDeviceData() {
+        if (!this.remote_device_data) {
+            return;
+        }
+        Object.assign(this, {
+            host: this.remote_device_data.host,
+            protocol: this.remote_device_data.protocol,
+            connection_mode: this.remote_device_data.connection_mode,
+            uom_category: this.uom.category_id[0],
+            device_uom: this.remote_device_data.uom_id[0],
+            device_uom_category: this.remote_device_data.uom_category_id[0],
+        });
+    }
+
+    /**
+     * @override
+     * @param {Event} ev
+     * Auto select all the content
+     */
+    onFocusIn(ev) {
+        super.onFocusIn(...arguments);
+        ev.target.select();
+    }
+    /**
+     * @override
+     * Ensure that the socket is close
+     */
+    onFocusOut() {
+        super.onFocusOut(...arguments);
+        this._closeSocket();
+    }
+
+    // UX Methods
+
+    async measure() {
+        this.state.stop = false;
+        this.state.measuring = true;
+        await this[`_connect_to_${this.connection_mode}`]();
+    }
+    /**
+     * Stop requesting measures from device
+     */
+    measure_stop() {
+        this._closeSocket();
+        this.state.stop = true;
+        this.state.measuring = false;
+        this._awaitingMeasure();
+        this._recordMeasure();
+    }
+    /**
+     * Start requesting measures from the remote device
+     */
+    onMeasure() {
+        this.state.icon = "fa-thermometer-empty";
+        this.measure();
+    }
+    onMeasureAdd() {
+        this.state.start_add = true;
+        this.measure();
+    }
+    /**
+     * Validate the requested measure
+     */
+    onValidateMeasure() {
+        this.measure_stop();
+    }
+
+    /**
+     * Once we consider the measure is stable render the button as green
+     */
+    _stableMeasure() {
+        this.state.class = "btn-success";
+    }
+    /**
+     * While a measure is not stable the button will be red
+     */
+    _unstableMeasure() {
+        this.state.class = "btn-danger";
+    }
+    /**
+     * While the widget isn't querying it will be purple as a signal that we can start
+     */
+    _awaitingMeasure() {
+        Object.assign(this.state, this.default_ui_state);
+    }
+    /**
+     * Set the field measure in the field
+     */
+    _recordMeasure() {
+        this.state.start_add = false;
+        this.state.input_val = this.amount;
+    }
+    /**
+     * Convert the measured units to the units expecte by the record if different
+     * @param {Number} amount
+     * @returns {Number} converted amount
+     */
+    _compute_quantity(amount) {
+        if (this.uom.id === this.device_uom.id) {
+            return amount;
+        }
+        let converted_amount = amount / this.remote_device_data.uom_factor;
+        converted_amount *= this.uom.factor;
+        return converted_amount;
+    }
+    /**
+     * Set value
+     */
+    async _setMeasure() {
+        if (isNaN(this.amount)) {
+            return;
+        }
+        this.amount = this._compute_quantity(this.amount);
+        if (this.state.start_add) {
+            this.amount += this.state.input_val;
+        }
+        this.props.record.update({[this.props.name]: this.amount});
+    }
+    nextStateIcon() {
+        this.state.icon = nextState[this.state.icon];
+    }
+
+    // Connection methods
+    // TODO: It'd be nice to extract al this logic to services although right now
+    // is quite intricate with te UI logic, so some refactor would be needed.
+
+    /**
+     * F501 Protocol response:
+     * [STX][status1][status2][data][ETX]
+     * - status1 beign weight status: \x20 (space) for stable weight and ? for unstable
+     * - status2 beign weight sign: + for positive and - for negative.
+     * - data being the weight itself with 6 characters for weight and one . for the
+     *   decimal dot
+     *
+     * @param {String} msg ASCII string
+     * @returns {Object} with the value and the stable flag
+     */
+    _proccess_msg_f501(msg) {
+        return {
+            stable: msg[1] === "\x20",
+            value: parseFloat(msg.slice(2, 10)),
+        };
+    }
+
+    /**
+     * Implemented for a continous remote stream
+     * TODO: Abstract more the possible device scenarios
+     */
+    async _connect_to_websockets() {
+        try {
+            this.socket = new WebSocket(this.host);
+        } catch (error) {
+            // Avoid websockets security error. Local devices won't have wss normally
+            if (error.code === 18) {
+                return;
+            }
+            throw error;
+        }
+        var stream_success_counter = 10;
+        this.socket.onmessage = async (msg) => {
+            const data = await msg.data.text();
+            const processed_data = this[`_proccess_msg_${this.protocol}`](data);
+            if (processed_data.stable) {
+                this._stableMeasure();
+                if (!stream_success_counter) {
+                    this._closeSocket();
+                    this._awaitingMeasure();
+                    this._recordMeasure();
+                    return;
+                }
+            } else {
+                stream_success_counter = 5;
+                this._unstableMeasure();
+            }
+            if (stream_success_counter) {
+                --stream_success_counter;
+            }
+            this.nextStateIcon();
+            this.amount = processed_data.value;
+            this._setMeasure();
+        };
+        this.socket.onerror = () => {
+            this._awaitingMeasure();
+        };
+    }
+    /**
+     * Send read params to the remote device
+     * @returns {Object}
+     */
+    _read_from_device_tcp_params() {
+        return {command: false};
+    }
+    /**
+     * Process call
+     * @returns {Number}
+     */
+    async _read_from_device_tcp() {
+        const data = await this.rpc(
+            `/remote_measure_device/${this.remote_device_data.id}`,
+            this._read_from_device_tcp_params()
+        );
+        if (!data) {
+            return null;
+        }
+        const processed_data = this[`_proccess_msg_${this.protocol}`](data);
+        if (isNaN(processed_data.value)) {
+            processed_data.value = 0;
+        }
+        return processed_data;
+    }
+    /**
+     * Connect to the local controller, which makes the direct connection to the
+     * scale.
+     */
+    async _connect_to_tcp() {
+        var stream_success_counter = 20;
+        this._unstableMeasure();
+        // Used to set the read interval if any
+        const timer = (ms) => new Promise((res) => setTimeout(res, ms));
+        // Don't keep going forever unless non stop reading
+        for (
+            let attemps_left = this.remote_device_data.non_stop_read ? Infinity : 1000;
+            attemps_left > 0;
+            attemps_left--
+        ) {
+            // Allow to break the loop manually
+            if (this.state.stop) {
+                break;
+            }
+            const processed_data = await this._read_from_device_tcp();
+            if (!processed_data) {
+                continue;
+            }
+            if (processed_data.stable) {
+                this._stableMeasure();
+            } else {
+                this._unstableMeasure();
+                stream_success_counter = 20;
+            }
+            if (processed_data.stable && stream_success_counter <= 0) {
+                this._stableMeasure();
+                this._awaitingMeasure();
+                this._recordMeasure();
+                break;
+            } else if (this.remote_device_data.non_stop_read) {
+                stream_success_counter = 20;
+                this._recordMeasure();
+            }
+            if (stream_success_counter) {
+                --stream_success_counter;
+            }
+            this.nextStateIcon();
+            this.amount = processed_data.value;
+            this._setMeasure();
+            // Set sleep interval
+            if (this.remote_device_data.read_interval) {
+                await timer(this.remote_device_data.read_interval);
+            }
+        }
+    }
+    /**
+     * Implement for your device protocol service
+     */
+    _connect_to_webservices() {
+        return;
+    }
+    /**
+     * Procure to close the socket whenever the widget stops being used
+     */
+    _closeSocket() {
+        if (this.socket) {
+            this.socket.close();
+            this.socket = undefined;
+        }
+    }
+}
+
+export const remoteMeasureField = {
+    ...floatField,
+    component: RemoteMeasureField,
+    supportedOptions: [
+        ...floatField.supportedOptions,
+        {
+            label: _t("UoM"),
+            name: "uom_field",
+            type: "field",
+            availableTypes: ["many2one"],
+        },
+        {
+            label: _t("Remote device"),
+            name: "remote_device_field",
+            type: "field",
+            availableTypes: ["many2one"],
+        },
+        {
+            label: _t("Use default device"),
+            name: "default_user_device",
+            type: "boolean",
+        },
+        {
+            label: _t("Additive Measure"),
+            name: "allow_additive_measure",
+            type: "boolean",
+        },
+    ],
+    extractProps({options}) {
+        const props = floatField.extractProps(...arguments);
+        props.remote_device_field = options.remote_device_field;
+        props.uom_field = options.uom_field;
+        props.default_user_device = options.default_user_device;
+        props.allow_additive_measure = options.allow_additive_measure;
+        return props;
+    },
+};
+
+registry.category("fields").add("remote_measure", remoteMeasureField);

odoo/addons/web_widget_remote_measure/static/src/{scss/remote_measure_widget.scss → remote_measure_field/remote_measure_field.scss}

@@ -1,12 +1,12 @@
 .o_field_widget {
-    &.o_field_remote_device {
+    &.o_field_remote_measure {
         display: inline-flex;
         > span,
         > button {
             flex: 0 0 auto;
         }
     }
-    &.o_field_remote_device {
+    &.o_field_remote_measure {
         &.o_input {
             align-items: baseline;
 
@@ -21,7 +21,7 @@
     .o_list_table {
         .o_data_row.o_selected_row
             > .o_data_cell:not(.o_readonly_modifier):not(.o_invisible_modifier) {
-            .o_field_remote_device input {
+            .o_field_remote_measure input {
                 width: 0;
                 margin: 0 4px;
             }

odoo/addons/web_widget_remote_measure/static/src/remote_measure_field/remote_measure_field.xml

@@ -0,0 +1,43 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<templates id="template" xml:space="preserve">
+    <t t-name="web_widget_remote_measure.RemoteMeasureField">
+        <span t-if="props.readonly" t-esc="formattedValue" />
+        <t t-else="">
+            <t t-if="this.remote_device_data">
+                <span
+                    t-if="this.state.stop"
+                    class="o_field_remote_device_start btn btn-primary btn-sm"
+                    t-on-click.prevent="onMeasure"
+                >
+                    <i t-attf-class="fa {{this.state.icon}}" role="img" />
+                </span>
+                <span
+                    t-elif="!this.state.stop"
+                    t-attf-class="o_field_remote_device_stop btn btn-sm {{ this.state.class }}"
+                    t-on-click.prevent="onValidateMeasure"
+                >
+                    <i t-attf-class="fa {{this.state.icon}}" role="img" />
+                </span>
+                <span
+                    t-if="this.state.additive_measure"
+                    class="o_field_remote_device_start btn btn-link btn-sm"
+                    t-on-click.prevent="onMeasureAdd"
+                >
+                    <i t-attf-class="fa fa-plus" role="img" />
+                </span>
+            </t>
+            <input
+                t-on-focusin="onFocusIn"
+                t-on-focusout="onFocusOut"
+                t-att-id="props.id"
+                t-ref="numpadDecimal"
+                t-att-placeholder="props.placeholder"
+                t-att-type="props.inputType"
+                inputmode="decimal"
+                class="o_input"
+                autocomplete="off"
+                t-att-step="props.step"
+            />
+        </t>
+    </t>
+</templates>

odoo/addons/web_widget_remote_measure/views/remote_measure_device_views.xml

@@ -11,7 +11,7 @@
                         name="test_tcp_connection"
                         class="oe_highlight"
                         groups="base.group_no_one"
-                        attrs="{'invisible': [('connection_mode', '!=', 'tcp')]}"
+                        invisible="connection_mode != 'tcp'"
                     />
                 </header>
                 <sheet>
@@ -20,7 +20,7 @@
                         name="web_ribbon"
                         title="Archived"
                         bg_color="bg-danger"
-                        attrs="{'invisible': [('active', '=', True)]}"
+                        invisible="active"
                     />
                     <div class="oe_title">
                         <h1><field name="name" placeholder="e.g. Dock 1 Scale" /></h1>
@@ -49,12 +49,18 @@
     <record id="measure_device_tree" model="ir.ui.view">
         <field name="model">remote.measure.device</field>
         <field name="arch" type="xml">
-            <tree>
+            <tree editable="top">
                 <field name="name" />
                 <field name="host" />
                 <field name="protocol" optional="show" />
                 <field name="uom_id" optional="show" />
                 <field name="connection_mode" optional="show" />
+                <field
+                    name="test_measure"
+                    optional="hide"
+                    widget="remote_measure"
+                    options="{'allow_additive_measure': True}"
+                />
             </tree>
         </field>
     </record>

{odoo_addon_web_widget_remote_measure-15.0.1.1.0.dist-info → odoo_addon_web_widget_remote_measure-17.0.1.0.0.4.dist-info}/METADATA

@@ -1,17 +1,17 @@
 Metadata-Version: 2.1
 Name: odoo-addon-web_widget_remote_measure
-Version: 15.0.1.1.0
+Version: 17.0.1.0.0.4
+Requires-Python: >=3.10
+Requires-Dist: odoo>=17.0a,<17.1dev
 Summary: Allows to connect to remote devices to record measures
 Home-page: https://github.com/OCA/stock-weighing
+License: AGPL-3
 Author: Tecnativa, Odoo Community Association (OCA)
 Author-email: support@odoo-community.org
-License: AGPL-3
 Classifier: Programming Language :: Python
 Classifier: Framework :: Odoo
-Classifier: Framework :: Odoo :: 15.0
+Classifier: Framework :: Odoo :: 17.0
 Classifier: License :: OSI Approved :: GNU Affero General Public License v3
-Requires-Python: >=3.8
-Requires-Dist: odoo<15.1dev,>=15.0a
 
 ============================
 Remote Measure Devices Input
@@ -22,7 +22,7 @@ Remote Measure Devices Input
    !! This file is generated by oca-gen-addon-readme !!
    !! changes will be overwritten.                   !!
    !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
-   !! source digest: sha256:e90b90010e6a00f6e63bc471ba0342f0ed21608944d223276fffcf69e5e102d6
+   !! source digest: sha256:da3f687629ae8a2ddd5133d846c7ea58650065bd0de8a5c9f78430ab5f336940
    !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
 
 .. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
@@ -32,20 +32,20 @@ Remote Measure Devices Input
     :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
     :alt: License: AGPL-3
 .. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fstock--weighing-lightgray.png?logo=github
-    :target: https://github.com/OCA/stock-weighing/tree/15.0/web_widget_remote_measure
+    :target: https://github.com/OCA/stock-weighing/tree/17.0/web_widget_remote_measure
     :alt: OCA/stock-weighing
 .. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
-    :target: https://translation.odoo-community.org/projects/stock-weighing-15-0/stock-weighing-15-0-web_widget_remote_measure
+    :target: https://translation.odoo-community.org/projects/stock-weighing-17-0/stock-weighing-17-0-web_widget_remote_measure
     :alt: Translate me on Weblate
 .. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png
-    :target: https://runboat.odoo-community.org/builds?repo=OCA/stock-weighing&target_branch=15.0
+    :target: https://runboat.odoo-community.org/builds?repo=OCA/stock-weighing&target_branch=17.0
     :alt: Try me on Runboat
 
 |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.
+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.
 
@@ -59,35 +59,40 @@ 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
+1. Go to *Settings > Technical > Devices > Remote devices*
+2. Create a new one configuring the required info.
+3. If the devices has an special port, set it up in the host data: e.g.:
+   10.1.1.2:3210
 
-If you want to see the button in the top bar to set the user's remote device, you need
-to have the "Show remote device button on navbar" group.
+If you want to see the button in the top bar to set the user's remote
+device, you need to have the "Show remote device button on navbar"
+group.
 
 Usage
 =====
 
-The remote device has to be in the users network so their web clients can reach them.
+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.
+1. Go to *Settings > Technical > Devices > Remote devices*
+2. In the Kanban view you'll wich devices can be reached as they'll have
+   a green dot in their card.
+3. Go to one of those and click *Edit*.
+4. 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.
+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'}" />
+   <field name="float_field" widget="remote_measure" options="{'remote_device_field': 'measure_device_id', 'uom_field': 'uom_id'}" />
 
-The users are able to change their default remote device by using the button with the
-balance icon set on the navbar.
+The users are able to change their default remote device by using the
+button with the balance icon set on the navbar.
 
 Known issues / Roadmap
 ======================
@@ -109,7 +114,7 @@ Bug Tracker
 Bugs are tracked on `GitHub Issues <https://github.com/OCA/stock-weighing/issues>`_.
 In case of trouble, please check there if your issue has already been reported.
 If you spotted it first, help us to smash it by providing a detailed and welcomed
-`feedback <https://github.com/OCA/stock-weighing/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**>`_.
+`feedback <https://github.com/OCA/stock-weighing/issues/new?body=module:%20web_widget_remote_measure%0Aversion:%2017.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.
 
@@ -117,21 +122,21 @@ Credits
 =======
 
 Authors
-~~~~~~~
+-------
 
 * Tecnativa
 
 Contributors
-~~~~~~~~~~~~
+------------
 
-* `Tecnativa <https://www.tecnativa.com>`_:
+- `Tecnativa <https://www.tecnativa.com>`__:
 
-  * David Vidal
-  * Sergio Teruel
-  * Carlos Roca
+  - David Vidal
+  - Sergio Teruel
+  - Carlos Roca
 
 Maintainers
-~~~~~~~~~~~
+-----------
 
 This module is maintained by the OCA.
 
@@ -151,6 +156,6 @@ Current `maintainer <https://odoo-community.org/page/maintainer-role>`__:
 
 |maintainer-chienandalu| 
 
-This module is part of the `OCA/stock-weighing <https://github.com/OCA/stock-weighing/tree/15.0/web_widget_remote_measure>`_ project on GitHub.
+This module is part of the `OCA/stock-weighing <https://github.com/OCA/stock-weighing/tree/17.0/web_widget_remote_measure>`_ project on GitHub.
 
 You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.