[ADD] stock_measuring_device_zippcube

support for Bosche Zippcube measuring devices

stock_measuring_device_zippcube/README.rst

@@ -0,0 +1,127 @@
+==============
+Stock Zippcube
+==============
+
+.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! This file is generated by oca-gen-addon-readme !!
+   !! changes will be overwritten.                   !!
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+.. |badge1| image:: https://img.shields.io/badge/maturity-Alpha-red.png
+    :target: https://odoo-community.org/page/development-status
+    :alt: Alpha
+.. |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%2Fstock--logistics--warehouse-lightgray.png?logo=github
+    :target: https://github.com/OCA/stock-logistics-warehouse/tree/13.0/stock_measuring_device_zippcube
+    :alt: OCA/stock-logistics-warehouse
+.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
+    :target: https://translation.odoo-community.org/projects/stock-logistics-warehouse-13-0/stock-logistics-warehouse-13-0-stock_measuring_device_zippcube
+    :alt: Translate me on Weblate
+.. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png
+    :target: https://runbot.odoo-community.org/runbot/153/13.0
+    :alt: Try me on Runbot
+
+|badge1| |badge2| |badge3| |badge4| |badge5| 
+
+Different manufacturers produce devices which are able to measure and weigh
+packages and parcels. Each brand has a different communication protocol. This
+module provides an framework to interface such devices with Odoo.
+
+This module provides support for Bosche Zippcube devices.
+
+
+https://www.bosche.eu/en/industrial-scales/logistic-scales/scales-for-logistic-and-transport/zippcube
+
+.. IMPORTANT::
+   This is an alpha version, the data model and design can change at any time without warning.
+   Only for development or testing purpose, do not use in production.
+   `More details on development status <https://odoo-community.org/page/development-status>`_
+
+**Table of contents**
+
+.. contents::
+   :local:
+
+Installation
+============
+
+To secure the communication, we use a pre-shared secret. Generate it with a
+tool able to generate a random string, such as uuidgen. Run Odoo with an
+environment variable called ZIPPCUBE_SECRET set to the value of the secret.
+
+After you have configured the measuring device in Odoo, you need to configure the device itself.
+
+Edit the language file on the computer attached to the device, and set the
+following parameters (the secret value must be the one generated earlier)::
+
+  REST_Body={"barcode":"%%VAR_NUMBER%%", "weight":"%%VAR_SCALE_WEIGHT%%",  "length":"%%VAR_LENGTH", "width":"%%VAR_WIDTH%%", "height":"%%VAR_HEIGHT%%", "secret": "<insert secret here>"}
+  REST_BaseURL=http://<odoo_host_url>/stock/zippcube/<device_name>/measurement
+  REST_ContentType=application/json
+  REST_AcceptEncoding=gzip, deflate
+
+For local testing you can use the script in `scripts/measurement.sh`
+
+Configuration
+=============
+
+Create a measuring device with a type set to "zippcube".
+
+Usage
+=====
+
+Use the "Wizard" button on a Measuring Device to open the screen and take
+measurements.
+
+After the measurement has been made, you need to click on the Refresh button.
+
+Bug Tracker
+===========
+
+Bugs are tracked on `GitHub Issues <https://github.com/OCA/stock-logistics-warehouse/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/stock-logistics-warehouse/issues/new?body=module:%20stock_measuring_device_zippcube%0Aversion:%2013.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
+~~~~~~~
+
+* Camptocamp
+
+Contributors
+~~~~~~~~~~~~
+
+* Patrick Tombez <patrick.tombez@camptocamp.com>
+* Alexandre Fayolle <alexandre.fayolle@camptocamp.com>
+* Carlos Serra Toro <carlos.serra@camptocamp.com>
+
+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-gurneyalex| image:: https://github.com/gurneyalex.png?size=40px
+    :target: https://github.com/gurneyalex
+    :alt: gurneyalex
+
+Current `maintainer <https://odoo-community.org/page/maintainer-role>`__:
+
+|maintainer-gurneyalex| 
+
+This module is part of the `OCA/stock-logistics-warehouse <https://github.com/OCA/stock-logistics-warehouse/tree/13.0/stock_measuring_device_zippcube>`_ project on GitHub.
+
+You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

stock_measuring_device_zippcube/__init__.py

@@ -0,0 +1,3 @@
+from . import components
+from . import controllers
+from . import models

stock_measuring_device_zippcube/__manifest__.py

@@ -0,0 +1,17 @@
+# Copyright 2021 Camptocamp SA
+# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html)
+{
+    "name": "Stock Zippcube",
+    "summary": "Implement interface with Bosche Zippcube devices"
+    "for packaging measurement",
+    "version": "13.0.1.0.0",
+    "category": "Warehouse",
+    "author": "Camptocamp, Odoo Community Association (OCA)",
+    "license": "AGPL-3",
+    "depends": ["stock_measuring_device", "web_notify"],
+    "data": [],
+    "website": "https://github.com/OCA/stock-logistics-warehouse",
+    "installable": True,
+    "development_status": "Alpha",
+    "maintainers": ["gurneyalex"],
+}

stock_measuring_device_zippcube/components/__init__.py

@@ -0,0 +1,3 @@
+# Copyright 2021 Camptocamp SA
+# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html)
+from . import zippcube_device_component

stock_measuring_device_zippcube/components/zippcube_device_component.py

@@ -0,0 +1,39 @@
+# Copyright 2021 Camptocamp SA
+# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html)
+
+import logging
+
+from odoo import _
+
+from odoo.addons.component.core import Component
+
+_logger = logging.getLogger(__name__)
+
+
+class ZippcubeDevice(Component):
+    _name = "device.component.zippcube"
+    _inherit = "measuring.device.base"
+    _usage = "zippcube"
+
+    def preprocess_measures(self, measures):
+        weight_keys = ("weight",)
+        measures_keys = ("length", "width", "height")
+        data = {}
+        for key in weight_keys + measures_keys:
+            value = measures[key]
+            if isinstance(value, str):
+                value = float(value.replace(",", "."))
+            if key in measures_keys:
+                # lengths are in cm -> convert to mm
+                value *= 10
+            data[key] = value
+        return {
+            "max_weight": data["weight"],
+            "lngth": data["length"],
+            "width": data["width"],
+            "height": data["height"],
+        }
+
+    def post_update_packaging_measures(self, measures, packaging, wizard_line):
+        wizard_line.wizard_id._notify(_("Please, press the REFRESH button."))
+        packaging._measuring_device_release()

stock_measuring_device_zippcube/controllers/__init__.py

@@ -0,0 +1 @@
+from . import main

stock_measuring_device_zippcube/controllers/main.py

@@ -0,0 +1,60 @@
+# Copyright 2021 Camptocamp SA
+# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html)
+import logging
+import os
+
+from odoo import _, http
+from odoo.exceptions import AccessError, MissingError
+from odoo.http import request
+
+_logger = logging.getLogger(__name__)
+
+
+class ZippcubeController(http.Controller):
+    DEVICE_SECRET_KEY = "ZIPPCUBE_SECRET"
+
+    weight_keys = ("weight",)
+    measures_keys = ("length", "width", "height")
+    expected_keys = ("secret", "barcode") + weight_keys + measures_keys
+
+    @http.route(
+        "/stock/zippcube/<string:zippcube_device_name>/measurement",
+        type="json",
+        auth="none",
+    )
+    def measurement(self, zippcube_device_name):
+        data = request.jsonrequest
+        _logger.info("/measurement, data received: {}".format(data))
+
+        env = request.env(su=True)
+        device = env["measuring.device"].search(
+            [("name", "=", zippcube_device_name), ("device_type", "=", "zippcube")],
+            limit=1,
+        )
+        if not device:
+            raise MissingError(
+                _("No such Zippcube with name {}.").format(zippcube_device_name)
+            )
+
+        keys_missing = set(self.expected_keys) - set(data)
+        keys_spurious = set(data) - set(self.expected_keys)
+        if keys_missing or keys_spurious:
+            error_msg = _(
+                "Wrong data format: {}. Keys missing: {}, Unexpected keys: {}"
+            ).format(data, keys_missing, keys_spurious)
+            _logger.error(error_msg)
+            raise ValueError(error_msg)
+
+        self._check_secret(data["secret"])
+        data.pop("secret")
+        device._update_packaging_measures(data)
+        return True
+
+    def _device_get_secret(self):
+        return os.environ.get(self.DEVICE_SECRET_KEY)
+
+    def _check_secret(self, secret):
+        if secret and secret == self._device_get_secret():
+            return True
+        else:
+            raise AccessError(_("ZIPPCUBE_SECRET is wrong or missing"))

stock_measuring_device_zippcube/i18n/stock_measuring_device_zippcube.pot

@@ -0,0 +1,60 @@
+# Translation of Odoo Server.
+# This file contains the translation of the following modules:
+# 	* stock_measuring_device_zippcube
+#
+msgid ""
+msgstr ""
+"Project-Id-Version: Odoo Server 13.0\n"
+"Report-Msgid-Bugs-To: \n"
+"Last-Translator: \n"
+"Language-Team: \n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: \n"
+"Plural-Forms: \n"
+
+#. module: stock_measuring_device_zippcube
+#: model:ir.model.fields,field_description:stock_measuring_device_zippcube.field_measuring_device__device_type
+msgid "Device Type"
+msgstr ""
+
+#. module: stock_measuring_device_zippcube
+#: model:ir.model,name:stock_measuring_device_zippcube.model_measuring_device
+msgid "Measuring and Weighing Device"
+msgstr ""
+
+#. module: stock_measuring_device_zippcube
+#: code:addons/stock_measuring_device_zippcube/controllers/main.py:0
+#, python-format
+msgid "No such Zippcube with name {}."
+msgstr ""
+
+#. module: stock_measuring_device_zippcube
+#: code:addons/stock_measuring_device_zippcube/components/zippcube_device_component.py:0
+#, python-format
+msgid "Please, press the REFRESH button."
+msgstr ""
+
+#. module: stock_measuring_device_zippcube
+#: model:ir.model.fields,help:stock_measuring_device_zippcube.field_measuring_device__device_type
+msgid ""
+"The type of device (e.g. zippcube, cubiscan...) depending on which module "
+"are installed."
+msgstr ""
+
+#. module: stock_measuring_device_zippcube
+#: code:addons/stock_measuring_device_zippcube/controllers/main.py:0
+#, python-format
+msgid "Wrong data format: {}. Keys missing: {}, Unexpected keys: {}"
+msgstr ""
+
+#. module: stock_measuring_device_zippcube
+#: code:addons/stock_measuring_device_zippcube/controllers/main.py:0
+#, python-format
+msgid "ZIPPCUBE_SECRET is wrong or missing"
+msgstr ""
+
+#. module: stock_measuring_device_zippcube
+#: model:ir.model.fields.selection,name:stock_measuring_device_zippcube.selection__measuring_device__device_type__zippcube
+msgid "Zippcube"
+msgstr ""

stock_measuring_device_zippcube/models/__init__.py

@@ -0,0 +1,3 @@
+# Copyright 2021 Camptocamp SA
+# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html)
+from . import measuring_device

stock_measuring_device_zippcube/models/measuring_device.py

@@ -0,0 +1,9 @@
+# Copyright 2021 Camptocamp SA
+# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html)
+from odoo import fields, models
+
+
+class MeasuringDevice(models.Model):
+    _inherit = "measuring.device"
+
+    device_type = fields.Selection(selection_add=[("zippcube", "Zippcube")])

stock_measuring_device_zippcube/readme/CONFIGURE.rst

@@ -0,0 +1 @@
+Create a measuring device with a type set to "zippcube".

stock_measuring_device_zippcube/readme/CONTRIBUTORS.rst

@@ -0,0 +1,3 @@
+* Patrick Tombez <patrick.tombez@camptocamp.com>
+* Alexandre Fayolle <alexandre.fayolle@camptocamp.com>
+* Carlos Serra Toro <carlos.serra@camptocamp.com>

stock_measuring_device_zippcube/readme/DESCRIPTION.rst

@@ -0,0 +1,8 @@
+Different manufacturers produce devices which are able to measure and weigh
+packages and parcels. Each brand has a different communication protocol. This
+module provides an framework to interface such devices with Odoo.
+
+This module provides support for Bosche Zippcube devices.
+
+
+https://www.bosche.eu/en/industrial-scales/logistic-scales/scales-for-logistic-and-transport/zippcube

stock_measuring_device_zippcube/readme/INSTALL.rst

@@ -0,0 +1,15 @@
+To secure the communication, we use a pre-shared secret. Generate it with a
+tool able to generate a random string, such as uuidgen. Run Odoo with an
+environment variable called ZIPPCUBE_SECRET set to the value of the secret.
+
+After you have configured the measuring device in Odoo, you need to configure the device itself.
+
+Edit the language file on the computer attached to the device, and set the
+following parameters (the secret value must be the one generated earlier)::
+
+  REST_Body={"barcode":"%%VAR_NUMBER%%", "weight":"%%VAR_SCALE_WEIGHT%%",  "length":"%%VAR_LENGTH", "width":"%%VAR_WIDTH%%", "height":"%%VAR_HEIGHT%%", "secret": "<insert secret here>"}
+  REST_BaseURL=http://<odoo_host_url>/stock/zippcube/<device_name>/measurement
+  REST_ContentType=application/json
+  REST_AcceptEncoding=gzip, deflate
+
+For local testing you can use the script in `scripts/measurement.sh`

stock_measuring_device_zippcube/readme/USAGE.rst

@@ -0,0 +1,4 @@
+Use the "Wizard" button on a Measuring Device to open the screen and take
+measurements.
+
+After the measurement has been made, you need to click on the Refresh button.

stock_measuring_device_zippcube/scripts/measurement.sh

@@ -0,0 +1,6 @@
+#!/bin/bash
+
+curl --header "Content-Type: application/json" \
+  --request POST \
+  --data '{"secret": "abcdefg", "barcode":"xyz", "weight": "12,3", "length": "123,1", "width": "456,5", "height": "789,2"}' \
+  http://localhost:8069/stock/zippcube/${DEVICE_NAME}/measurement

stock_measuring_device_zippcube/static/description/index.html

@@ -0,0 +1,462 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<meta name="generator" content="Docutils 0.15.1: http://docutils.sourceforge.net/" />
+<title>Stock Zippcube</title>
+<style type="text/css">
+
+/*
+:Author: David Goodger (goodger@python.org)
+:Id: $Id: html4css1.css 7952 2016-07-26 18:15:59Z milde $
+:Copyright: This stylesheet has been placed in the public domain.
+
+Default cascading style sheet for the HTML output of Docutils.
+
+See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to
+customize this style sheet.
+*/
+
+/* used to remove borders from tables and images */
+.borderless, table.borderless td, table.borderless th {
+  border: 0 }
+
+table.borderless td, table.borderless th {
+  /* Override padding for "table.docutils td" with "! important".
+     The right padding separates the table cells. */
+  padding: 0 0.5em 0 0 ! important }
+
+.first {
+  /* Override more specific margin styles with "! important". */
+  margin-top: 0 ! important }
+
+.last, .with-subtitle {
+  margin-bottom: 0 ! important }
+
+.hidden {
+  display: none }
+
+.subscript {
+  vertical-align: sub;
+  font-size: smaller }
+
+.superscript {
+  vertical-align: super;
+  font-size: smaller }
+
+a.toc-backref {
+  text-decoration: none ;
+  color: black }
+
+blockquote.epigraph {
+  margin: 2em 5em ; }
+
+dl.docutils dd {
+  margin-bottom: 0.5em }
+
+object[type="image/svg+xml"], object[type="application/x-shockwave-flash"] {
+  overflow: hidden;
+}
+
+/* Uncomment (and remove this text!) to get bold-faced definition list terms
+dl.docutils dt {
+  font-weight: bold }
+*/
+
+div.abstract {
+  margin: 2em 5em }
+
+div.abstract p.topic-title {
+  font-weight: bold ;
+  text-align: center }
+
+div.admonition, div.attention, div.caution, div.danger, div.error,
+div.hint, div.important, div.note, div.tip, div.warning {
+  margin: 2em ;
+  border: medium outset ;
+  padding: 1em }
+
+div.admonition p.admonition-title, div.hint p.admonition-title,
+div.important p.admonition-title, div.note p.admonition-title,
+div.tip p.admonition-title {
+  font-weight: bold ;
+  font-family: sans-serif }
+
+div.attention p.admonition-title, div.caution p.admonition-title,
+div.danger p.admonition-title, div.error p.admonition-title,
+div.warning p.admonition-title, .code .error {
+  color: red ;
+  font-weight: bold ;
+  font-family: sans-serif }
+
+/* Uncomment (and remove this text!) to get reduced vertical space in
+   compound paragraphs.
+div.compound .compound-first, div.compound .compound-middle {
+  margin-bottom: 0.5em }
+
+div.compound .compound-last, div.compound .compound-middle {
+  margin-top: 0.5em }
+*/
+
+div.dedication {
+  margin: 2em 5em ;
+  text-align: center ;
+  font-style: italic }
+
+div.dedication p.topic-title {
+  font-weight: bold ;
+  font-style: normal }
+
+div.figure {
+  margin-left: 2em ;
+  margin-right: 2em }
+
+div.footer, div.header {
+  clear: both;
+  font-size: smaller }
+
+div.line-block {
+  display: block ;
+  margin-top: 1em ;
+  margin-bottom: 1em }
+
+div.line-block div.line-block {
+  margin-top: 0 ;
+  margin-bottom: 0 ;
+  margin-left: 1.5em }
+
+div.sidebar {
+  margin: 0 0 0.5em 1em ;
+  border: medium outset ;
+  padding: 1em ;
+  background-color: #ffffee ;
+  width: 40% ;
+  float: right ;
+  clear: right }
+
+div.sidebar p.rubric {
+  font-family: sans-serif ;
+  font-size: medium }
+
+div.system-messages {
+  margin: 5em }
+
+div.system-messages h1 {
+  color: red }
+
+div.system-message {
+  border: medium outset ;
+  padding: 1em }
+
+div.system-message p.system-message-title {
+  color: red ;
+  font-weight: bold }
+
+div.topic {
+  margin: 2em }
+
+h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
+h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
+  margin-top: 0.4em }
+
+h1.title {
+  text-align: center }
+
+h2.subtitle {
+  text-align: center }
+
+hr.docutils {
+  width: 75% }
+
+img.align-left, .figure.align-left, object.align-left, table.align-left {
+  clear: left ;
+  float: left ;
+  margin-right: 1em }
+
+img.align-right, .figure.align-right, object.align-right, table.align-right {
+  clear: right ;
+  float: right ;
+  margin-left: 1em }
+
+img.align-center, .figure.align-center, object.align-center {
+  display: block;
+  margin-left: auto;
+  margin-right: auto;
+}
+
+table.align-center {
+  margin-left: auto;
+  margin-right: auto;
+}
+
+.align-left {
+  text-align: left }
+
+.align-center {
+  clear: both ;
+  text-align: center }
+
+.align-right {
+  text-align: right }
+
+/* reset inner alignment in figures */
+div.align-right {
+  text-align: inherit }
+
+/* div.align-center * { */
+/*   text-align: left } */
+
+.align-top    {
+  vertical-align: top }
+
+.align-middle {
+  vertical-align: middle }
+
+.align-bottom {
+  vertical-align: bottom }
+
+ol.simple, ul.simple {
+  margin-bottom: 1em }
+
+ol.arabic {
+  list-style: decimal }
+
+ol.loweralpha {
+  list-style: lower-alpha }
+
+ol.upperalpha {
+  list-style: upper-alpha }
+
+ol.lowerroman {
+  list-style: lower-roman }
+
+ol.upperroman {
+  list-style: upper-roman }
+
+p.attribution {
+  text-align: right ;
+  margin-left: 50% }
+
+p.caption {
+  font-style: italic }
+
+p.credits {
+  font-style: italic ;
+  font-size: smaller }
+
+p.label {
+  white-space: nowrap }
+
+p.rubric {
+  font-weight: bold ;
+  font-size: larger ;
+  color: maroon ;
+  text-align: center }
+
+p.sidebar-title {
+  font-family: sans-serif ;
+  font-weight: bold ;
+  font-size: larger }
+
+p.sidebar-subtitle {
+  font-family: sans-serif ;
+  font-weight: bold }
+
+p.topic-title {
+  font-weight: bold }
+
+pre.address {
+  margin-bottom: 0 ;
+  margin-top: 0 ;
+  font: inherit }
+
+pre.literal-block, pre.doctest-block, pre.math, pre.code {
+  margin-left: 2em ;
+  margin-right: 2em }
+
+pre.code .ln { color: grey; } /* line numbers */
+pre.code, code { background-color: #eeeeee }
+pre.code .comment, code .comment { color: #5C6576 }
+pre.code .keyword, code .keyword { color: #3B0D06; font-weight: bold }
+pre.code .literal.string, code .literal.string { color: #0C5404 }
+pre.code .name.builtin, code .name.builtin { color: #352B84 }
+pre.code .deleted, code .deleted { background-color: #DEB0A1}
+pre.code .inserted, code .inserted { background-color: #A3D289}
+
+span.classifier {
+  font-family: sans-serif ;
+  font-style: oblique }
+
+span.classifier-delimiter {
+  font-family: sans-serif ;
+  font-weight: bold }
+
+span.interpreted {
+  font-family: sans-serif }
+
+span.option {
+  white-space: nowrap }
+
+span.pre {
+  white-space: pre }
+
+span.problematic {
+  color: red }
+
+span.section-subtitle {
+  /* font-size relative to parent (h1..h6 element) */
+  font-size: 80% }
+
+table.citation {
+  border-left: solid 1px gray;
+  margin-left: 1px }
+
+table.docinfo {
+  margin: 2em 4em }
+
+table.docutils {
+  margin-top: 0.5em ;
+  margin-bottom: 0.5em }
+
+table.footnote {
+  border-left: solid 1px black;
+  margin-left: 1px }
+
+table.docutils td, table.docutils th,
+table.docinfo td, table.docinfo th {
+  padding-left: 0.5em ;
+  padding-right: 0.5em ;
+  vertical-align: top }
+
+table.docutils th.field-name, table.docinfo th.docinfo-name {
+  font-weight: bold ;
+  text-align: left ;
+  white-space: nowrap ;
+  padding-left: 0 }
+
+/* "booktabs" style (no vertical lines) */
+table.docutils.booktabs {
+  border: 0px;
+  border-top: 2px solid;
+  border-bottom: 2px solid;
+  border-collapse: collapse;
+}
+table.docutils.booktabs * {
+  border: 0px;
+}
+table.docutils.booktabs th {
+  border-bottom: thin solid;
+  text-align: left;
+}
+
+h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
+h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
+  font-size: 100% }
+
+ul.auto-toc {
+  list-style-type: none }
+
+</style>
+</head>
+<body>
+<div class="document" id="stock-zippcube">
+<h1 class="title">Stock Zippcube</h1>
+
+<!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+!! This file is generated by oca-gen-addon-readme !!
+!! changes will be overwritten.                   !!
+!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
+<p><a class="reference external" href="https://odoo-community.org/page/development-status"><img alt="Alpha" src="https://img.shields.io/badge/maturity-Alpha-red.png" /></a> <a class="reference external" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.png" /></a> <a class="reference external" href="https://github.com/OCA/stock-logistics-warehouse/tree/13.0/stock_measuring_device_zippcube"><img alt="OCA/stock-logistics-warehouse" src="https://img.shields.io/badge/github-OCA%2Fstock--logistics--warehouse-lightgray.png?logo=github" /></a> <a class="reference external" href="https://translation.odoo-community.org/projects/stock-logistics-warehouse-13-0/stock-logistics-warehouse-13-0-stock_measuring_device_zippcube"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external" href="https://runbot.odoo-community.org/runbot/153/13.0"><img alt="Try me on Runbot" src="https://img.shields.io/badge/runbot-Try%20me-875A7B.png" /></a></p>
+<p>Different manufacturers produce devices which are able to measure and weigh
+packages and parcels. Each brand has a different communication protocol. This
+module provides an framework to interface such devices with Odoo.</p>
+<p>This module provides support for Bosche Zippcube devices.</p>
+<p><a class="reference external" href="https://www.bosche.eu/en/industrial-scales/logistic-scales/scales-for-logistic-and-transport/zippcube">https://www.bosche.eu/en/industrial-scales/logistic-scales/scales-for-logistic-and-transport/zippcube</a></p>
+<div class="admonition important">
+<p class="first admonition-title">Important</p>
+<p class="last">This is an alpha version, the data model and design can change at any time without warning.
+Only for development or testing purpose, do not use in production.
+<a class="reference external" href="https://odoo-community.org/page/development-status">More details on development status</a></p>
+</div>
+<p><strong>Table of contents</strong></p>
+<div class="contents local topic" id="contents">
+<ul class="simple">
+<li><a class="reference internal" href="#installation" id="id1">Installation</a></li>
+<li><a class="reference internal" href="#configuration" id="id2">Configuration</a></li>
+<li><a class="reference internal" href="#usage" id="id3">Usage</a></li>
+<li><a class="reference internal" href="#bug-tracker" id="id4">Bug Tracker</a></li>
+<li><a class="reference internal" href="#credits" id="id5">Credits</a><ul>
+<li><a class="reference internal" href="#authors" id="id6">Authors</a></li>
+<li><a class="reference internal" href="#contributors" id="id7">Contributors</a></li>
+<li><a class="reference internal" href="#maintainers" id="id8">Maintainers</a></li>
+</ul>
+</li>
+</ul>
+</div>
+<div class="section" id="installation">
+<h1><a class="toc-backref" href="#id1">Installation</a></h1>
+<p>To secure the communication, we use a pre-shared secret. Generate it with a
+tool able to generate a random string, such as uuidgen. Run Odoo with an
+environment variable called ZIPPCUBE_SECRET set to the value of the secret.</p>
+<p>After you have configured the measuring device in Odoo, you need to configure the device itself.</p>
+<p>Edit the language file on the computer attached to the device, and set the
+following parameters (the secret value must be the one generated earlier):</p>
+<pre class="literal-block">
+REST_Body={&quot;barcode&quot;:&quot;%%VAR_NUMBER%%&quot;, &quot;weight&quot;:&quot;%%VAR_SCALE_WEIGHT%%&quot;,  &quot;length&quot;:&quot;%%VAR_LENGTH&quot;, &quot;width&quot;:&quot;%%VAR_WIDTH%%&quot;, &quot;height&quot;:&quot;%%VAR_HEIGHT%%&quot;, &quot;secret&quot;: &quot;&lt;insert secret here&gt;&quot;}
+REST_BaseURL=http://&lt;odoo_host_url&gt;/stock/zippcube/&lt;device_name&gt;/measurement
+REST_ContentType=application/json
+REST_AcceptEncoding=gzip, deflate
+</pre>
+<p>For local testing you can use the script in <cite>scripts/measurement.sh</cite></p>
+</div>
+<div class="section" id="configuration">
+<h1><a class="toc-backref" href="#id2">Configuration</a></h1>
+<p>Create a measuring device with a type set to “zippcube”.</p>
+</div>
+<div class="section" id="usage">
+<h1><a class="toc-backref" href="#id3">Usage</a></h1>
+<p>Use the “Wizard” button on a Measuring Device to open the screen and take
+measurements.</p>
+<p>After the measurement has been made, you need to click on the Refresh button.</p>
+</div>
+<div class="section" id="bug-tracker">
+<h1><a class="toc-backref" href="#id4">Bug Tracker</a></h1>
+<p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/stock-logistics-warehouse/issues">GitHub Issues</a>.
+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
+<a class="reference external" href="https://github.com/OCA/stock-logistics-warehouse/issues/new?body=module:%20stock_measuring_device_zippcube%0Aversion:%2013.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
+<p>Do not contact contributors directly about support or help with technical issues.</p>
+</div>
+<div class="section" id="credits">
+<h1><a class="toc-backref" href="#id5">Credits</a></h1>
+<div class="section" id="authors">
+<h2><a class="toc-backref" href="#id6">Authors</a></h2>
+<ul class="simple">
+<li>Camptocamp</li>
+</ul>
+</div>
+<div class="section" id="contributors">
+<h2><a class="toc-backref" href="#id7">Contributors</a></h2>
+<ul class="simple">
+<li>Patrick Tombez &lt;<a class="reference external" href="mailto:patrick.tombez&#64;camptocamp.com">patrick.tombez&#64;camptocamp.com</a>&gt;</li>
+<li>Alexandre Fayolle &lt;<a class="reference external" href="mailto:alexandre.fayolle&#64;camptocamp.com">alexandre.fayolle&#64;camptocamp.com</a>&gt;</li>
+<li>Carlos Serra Toro &lt;<a class="reference external" href="mailto:carlos.serra&#64;camptocamp.com">carlos.serra&#64;camptocamp.com</a>&gt;</li>
+</ul>
+</div>
+<div class="section" id="maintainers">
+<h2><a class="toc-backref" href="#id8">Maintainers</a></h2>
+<p>This module is maintained by the OCA.</p>
+<a class="reference external image-reference" href="https://odoo-community.org"><img alt="Odoo Community Association" src="https://odoo-community.org/logo.png" /></a>
+<p>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.</p>
+<p>Current <a class="reference external" href="https://odoo-community.org/page/maintainer-role">maintainer</a>:</p>
+<p><a class="reference external" href="https://github.com/gurneyalex"><img alt="gurneyalex" src="https://github.com/gurneyalex.png?size=40px" /></a></p>
+<p>This module is part of the <a class="reference external" href="https://github.com/OCA/stock-logistics-warehouse/tree/13.0/stock_measuring_device_zippcube">OCA/stock-logistics-warehouse</a> project on GitHub.</p>
+<p>You are welcome to contribute. To learn how please visit <a class="reference external" href="https://odoo-community.org/page/Contribute">https://odoo-community.org/page/Contribute</a>.</p>
+</div>
+</div>
+</div>
+</body>
+</html>

stock_measuring_device_zippcube/tests/__init__.py

@@ -0,0 +1 @@
+from . import test_zippcube_wizard

stock_measuring_device_zippcube/tests/test_zippcube_wizard.py

@@ -0,0 +1,134 @@
+# Copyright 2021 Camptocamp SA
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl.html).
+
+from odoo.addons.component.tests.common import SavepointComponentCase
+
+
+class TestZippcubeWizard(SavepointComponentCase):
+    @staticmethod
+    def get_measure_result(length, width, height, weight):
+        return {
+            "length": length,
+            "width": width,
+            "height": height,
+            "weight": weight,
+        }
+
+    @classmethod
+    def setUpClass(cls):
+        super().setUpClass()
+        cls.env = cls.env(context=dict(cls.env.context, tracking_disable=True))
+
+        cls.device_obj = cls.env["measuring.device"]
+        cls.cs_wizard = cls.env["measuring.wizard"]
+        PackType = cls.env["product.packaging.type"]
+        pack_type_data = [
+            ("internal", 3, 1, 0),
+            ("retail", 10, 1, 1),
+            ("transport", 20, 1, 1),
+            ("pallet", 30, 1, 1),
+        ]
+        for name, seq, gtin, req in pack_type_data:
+            PackType.create(
+                {
+                    "name": name,
+                    "code": name.upper(),
+                    "sequence": seq,
+                    "has_gtin": gtin,
+                    "required": req,
+                }
+            )
+
+        cls.device = cls.device_obj.create(
+            {
+                "name": "Test Device",
+                "device_type": "zippcube",
+                "state": "ready",
+                "warehouse_id": 1,
+            }
+        )
+
+        # FIXME: use odoo.test.common.Form so that onchange are played
+        # automatically
+        cls.wizard = cls.cs_wizard.create({"device_id": cls.device.id})
+
+        cls.product_1 = cls.env.ref("product.product_product_6")
+        cls.product_2 = cls.env.ref("product.product_product_7")
+
+        cls.product_1.barcode = "424242"
+        PackType.cron_check_create_required_packaging()
+
+    def test_product_onchange(self):
+        self.wizard.product_id = self.product_1.id
+
+        self.assertEqual(len(self.wizard.line_ids), 0)
+        self.wizard.onchange_product_id()
+        self.assertEqual(len(self.wizard.line_ids), 6)
+
+    def test_product_onchange_barcode(self):
+        self.assertFalse(self.wizard.product_id)
+        self.assertFalse(self.wizard.line_ids)
+
+        self.wizard.on_barcode_scanned("424242")
+        self.wizard.onchange_product_id()
+        self.assertEqual(self.wizard.product_id, self.product_1)
+        self.assertEqual(len(self.wizard.line_ids), 6)
+
+    def test_zippcube_measures(self):
+        self.wizard.product_id = self.product_1.id
+        self.wizard.onchange_product_id()
+        for idx, line in enumerate(self.wizard.line_ids):
+            return_value = TestZippcubeWizard.get_measure_result(
+                100 * 2 ** idx, 100, 100, 3 ** idx
+            )
+            line.measuring_select_for_measure()
+            self.device._update_packaging_measures(return_value)
+            self.assertEqual(
+                line.read(["lngth", "width", "height", "max_weight", "volume"])[0],
+                {
+                    "id": line.id,
+                    "lngth": (2 ** idx) * 1000,
+                    "width": 1000,
+                    "height": 1000,
+                    "max_weight": 3.0 ** idx,
+                    "volume": 2.0 ** idx,
+                },
+            )
+
+        self.wizard.action_save()
+        mm_uom = self.env.ref("stock_measuring_device.product_uom_mm")
+        self.assertEqual(
+            self.product_1.read(
+                [
+                    "product_length",
+                    "product_width",
+                    "product_height",
+                    "weight",
+                    "volume",
+                    "dimensional_uom_id",
+                ]
+            )[0],
+            {
+                "id": self.product_1.id,
+                "product_length": 1000,
+                "product_width": 1000,
+                "product_height": 1000,
+                "weight": 1.0,
+                "volume": 1.0,
+                "dimensional_uom_id": (mm_uom.id, mm_uom.name),
+            },
+        )
+        packagings = self.product_1.packaging_ids.sorted()
+        self.assertEqual(len(packagings), 5)
+        for idx, packaging in enumerate(packagings, 1):
+            self.assertEqual(
+                packaging.read(["lngth", "width", "height", "max_weight", "volume"])[0],
+                {
+                    "id": packaging.id,
+                    "lngth": (2 ** idx) * 1000,
+                    "width": 1000,
+                    "height": 1000,
+                    "max_weight": 3.0 ** idx,
+                    "volume": 2.0 ** idx,
+                },
+            )