From db6e0e51428992891ed30bfe82707ed1ab5b212a Mon Sep 17 00:00:00 2001 From: Alexandre Fayolle Date: Thu, 15 Apr 2021 18:13:47 +0200 Subject: [PATCH] [ADD] stock_measuring_device_zippcube support for Bosche Zippcube measuring devices --- stock_measuring_device_zippcube/README.rst | 127 +++++ stock_measuring_device_zippcube/__init__.py | 3 + .../__manifest__.py | 17 + .../components/__init__.py | 3 + .../components/zippcube_device_component.py | 39 ++ .../controllers/__init__.py | 1 + .../controllers/main.py | 60 +++ .../i18n/stock_measuring_device_zippcube.pot | 60 +++ .../models/__init__.py | 3 + .../models/measuring_device.py | 9 + .../readme/CONFIGURE.rst | 1 + .../readme/CONTRIBUTORS.rst | 3 + .../readme/DESCRIPTION.rst | 8 + .../readme/INSTALL.rst | 15 + .../readme/ROADMAP.rst | 0 .../readme/USAGE.rst | 4 + .../scripts/measurement.sh | 6 + .../static/description/icon.png | Bin 0 -> 9455 bytes .../static/description/index.html | 462 ++++++++++++++++++ .../tests/__init__.py | 1 + .../tests/test_zippcube_wizard.py | 134 +++++ 21 files changed, 956 insertions(+) create mode 100644 stock_measuring_device_zippcube/README.rst create mode 100644 stock_measuring_device_zippcube/__init__.py create mode 100644 stock_measuring_device_zippcube/__manifest__.py create mode 100644 stock_measuring_device_zippcube/components/__init__.py create mode 100644 stock_measuring_device_zippcube/components/zippcube_device_component.py create mode 100644 stock_measuring_device_zippcube/controllers/__init__.py create mode 100644 stock_measuring_device_zippcube/controllers/main.py create mode 100644 stock_measuring_device_zippcube/i18n/stock_measuring_device_zippcube.pot create mode 100644 stock_measuring_device_zippcube/models/__init__.py create mode 100644 stock_measuring_device_zippcube/models/measuring_device.py create mode 100644 stock_measuring_device_zippcube/readme/CONFIGURE.rst create mode 100644 stock_measuring_device_zippcube/readme/CONTRIBUTORS.rst create mode 100644 stock_measuring_device_zippcube/readme/DESCRIPTION.rst create mode 100644 stock_measuring_device_zippcube/readme/INSTALL.rst create mode 100644 stock_measuring_device_zippcube/readme/ROADMAP.rst create mode 100644 stock_measuring_device_zippcube/readme/USAGE.rst create mode 100755 stock_measuring_device_zippcube/scripts/measurement.sh create mode 100644 stock_measuring_device_zippcube/static/description/icon.png create mode 100644 stock_measuring_device_zippcube/static/description/index.html create mode 100644 stock_measuring_device_zippcube/tests/__init__.py create mode 100644 stock_measuring_device_zippcube/tests/test_zippcube_wizard.py diff --git a/stock_measuring_device_zippcube/README.rst b/stock_measuring_device_zippcube/README.rst new file mode 100644 index 000000000..746f9a79b --- /dev/null +++ b/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 `_ + +**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": ""} + REST_BaseURL=http:///stock/zippcube//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 `_. +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 `_. + +Do not contact contributors directly about support or help with technical issues. + +Credits +======= + +Authors +~~~~~~~ + +* Camptocamp + +Contributors +~~~~~~~~~~~~ + +* Patrick Tombez +* Alexandre Fayolle +* Carlos Serra Toro + +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 `__: + +|maintainer-gurneyalex| + +This module is part of the `OCA/stock-logistics-warehouse `_ project on GitHub. + +You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. diff --git a/stock_measuring_device_zippcube/__init__.py b/stock_measuring_device_zippcube/__init__.py new file mode 100644 index 000000000..76a896a43 --- /dev/null +++ b/stock_measuring_device_zippcube/__init__.py @@ -0,0 +1,3 @@ +from . import components +from . import controllers +from . import models diff --git a/stock_measuring_device_zippcube/__manifest__.py b/stock_measuring_device_zippcube/__manifest__.py new file mode 100644 index 000000000..45d33a533 --- /dev/null +++ b/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"], +} diff --git a/stock_measuring_device_zippcube/components/__init__.py b/stock_measuring_device_zippcube/components/__init__.py new file mode 100644 index 000000000..0d5ce1cf0 --- /dev/null +++ b/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 diff --git a/stock_measuring_device_zippcube/components/zippcube_device_component.py b/stock_measuring_device_zippcube/components/zippcube_device_component.py new file mode 100644 index 000000000..4c009d41b --- /dev/null +++ b/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() diff --git a/stock_measuring_device_zippcube/controllers/__init__.py b/stock_measuring_device_zippcube/controllers/__init__.py new file mode 100644 index 000000000..12a7e529b --- /dev/null +++ b/stock_measuring_device_zippcube/controllers/__init__.py @@ -0,0 +1 @@ +from . import main diff --git a/stock_measuring_device_zippcube/controllers/main.py b/stock_measuring_device_zippcube/controllers/main.py new file mode 100644 index 000000000..2eeb03d21 --- /dev/null +++ b/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//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")) diff --git a/stock_measuring_device_zippcube/i18n/stock_measuring_device_zippcube.pot b/stock_measuring_device_zippcube/i18n/stock_measuring_device_zippcube.pot new file mode 100644 index 000000000..9b919b82e --- /dev/null +++ b/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 "" diff --git a/stock_measuring_device_zippcube/models/__init__.py b/stock_measuring_device_zippcube/models/__init__.py new file mode 100644 index 000000000..186d01f41 --- /dev/null +++ b/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 diff --git a/stock_measuring_device_zippcube/models/measuring_device.py b/stock_measuring_device_zippcube/models/measuring_device.py new file mode 100644 index 000000000..40b40b2c8 --- /dev/null +++ b/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")]) diff --git a/stock_measuring_device_zippcube/readme/CONFIGURE.rst b/stock_measuring_device_zippcube/readme/CONFIGURE.rst new file mode 100644 index 000000000..35d7d9a7c --- /dev/null +++ b/stock_measuring_device_zippcube/readme/CONFIGURE.rst @@ -0,0 +1 @@ +Create a measuring device with a type set to "zippcube". diff --git a/stock_measuring_device_zippcube/readme/CONTRIBUTORS.rst b/stock_measuring_device_zippcube/readme/CONTRIBUTORS.rst new file mode 100644 index 000000000..61b56b03d --- /dev/null +++ b/stock_measuring_device_zippcube/readme/CONTRIBUTORS.rst @@ -0,0 +1,3 @@ +* Patrick Tombez +* Alexandre Fayolle +* Carlos Serra Toro diff --git a/stock_measuring_device_zippcube/readme/DESCRIPTION.rst b/stock_measuring_device_zippcube/readme/DESCRIPTION.rst new file mode 100644 index 000000000..1b741b808 --- /dev/null +++ b/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 diff --git a/stock_measuring_device_zippcube/readme/INSTALL.rst b/stock_measuring_device_zippcube/readme/INSTALL.rst new file mode 100644 index 000000000..bad5af92b --- /dev/null +++ b/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": ""} + REST_BaseURL=http:///stock/zippcube//measurement + REST_ContentType=application/json + REST_AcceptEncoding=gzip, deflate + +For local testing you can use the script in `scripts/measurement.sh` diff --git a/stock_measuring_device_zippcube/readme/ROADMAP.rst b/stock_measuring_device_zippcube/readme/ROADMAP.rst new file mode 100644 index 000000000..e69de29bb diff --git a/stock_measuring_device_zippcube/readme/USAGE.rst b/stock_measuring_device_zippcube/readme/USAGE.rst new file mode 100644 index 000000000..cb050dfb1 --- /dev/null +++ b/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. diff --git a/stock_measuring_device_zippcube/scripts/measurement.sh b/stock_measuring_device_zippcube/scripts/measurement.sh new file mode 100755 index 000000000..7db7e4d91 --- /dev/null +++ b/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 diff --git a/stock_measuring_device_zippcube/static/description/icon.png b/stock_measuring_device_zippcube/static/description/icon.png new file mode 100644 index 0000000000000000000000000000000000000000..3a0328b516c4980e8e44cdb63fd945757ddd132d GIT binary patch literal 9455 zcmW++2RxMjAAjx~&dlBk9S+%}OXg)AGE&Cb*&}d0jUxM@u(PQx^-s)697TX`ehR4?GS^qbkof1cslKgkU)h65qZ9Oc=ml_0temigYLJfnz{IDzUf>bGs4N!v3=Z3jMq&A#7%rM5eQ#dc?k~! zVpnB`o+K7|Al`Q_U;eD$B zfJtP*jH`siUq~{KE)`jP2|#TUEFGRryE2`i0**z#*^6~AI|YzIWy$Cu#CSLW3q=GA z6`?GZymC;dCPk~rBS%eCb`5OLr;RUZ;D`}um=H)BfVIq%7VhiMr)_#G0N#zrNH|__ zc+blN2UAB0=617@>_u;MPHN;P;N#YoE=)R#i$k_`UAA>WWCcEVMh~L_ zj--gtp&|K1#58Yz*AHCTMziU1Jzt_jG0I@qAOHsk$2}yTmVkBp_eHuY$A9)>P6o~I z%aQ?!(GqeQ-Y+b0I(m9pwgi(IIZZzsbMv+9w{PFtd_<_(LA~0H(xz{=FhLB@(1&qHA5EJw1>>=%q2f&^X>IQ{!GJ4e9U z&KlB)z(84HmNgm2hg2C0>WM{E(DdPr+EeU_N@57;PC2&DmGFW_9kP&%?X4}+xWi)( z;)z%wI5>D4a*5XwD)P--sPkoY(a~WBw;E~AW`Yue4kFa^LM3X`8x|}ZUeMnqr}>kH zG%WWW>3ml$Yez?i%)2pbKPI7?5o?hydokgQyZsNEr{a|mLdt;X2TX(#B1j35xPnPW z*bMSSOauW>o;*=kO8ojw91VX!qoOQb)zHJ!odWB}d+*K?#sY_jqPdg{Sm2HdYzdEx zOGVPhVRTGPtv0o}RfVP;Nd(|CB)I;*t&QO8h zFfekr30S!-LHmV_Su-W+rEwYXJ^;6&3|L$mMC8*bQptyOo9;>Qb9Q9`ySe3%V$A*9 zeKEe+b0{#KWGp$F+tga)0RtI)nhMa-K@JS}2krK~n8vJ=Ngm?R!9G<~RyuU0d?nz# z-5EK$o(!F?hmX*2Yt6+coY`6jGbb7tF#6nHA zuKk=GGJ;ZwON1iAfG$E#Y7MnZVmrY|j0eVI(DN_MNFJmyZ|;w4tf@=CCDZ#5N_0K= z$;R~bbk?}TpfDjfB&aiQ$VA}s?P}xPERJG{kxk5~R`iRS(SK5d+Xs9swCozZISbnS zk!)I0>t=A<-^z(cmSFz3=jZ23u13X><0b)P)^1T_))Kr`e!-pb#q&J*Q`p+B6la%C zuVl&0duN<;uOsB3%T9Fp8t{ED108<+W(nOZd?gDnfNBC3>M8WE61$So|P zVvqH0SNtDTcsUdzaMDpT=Ty0pDHHNL@Z0w$Y`XO z2M-_r1S+GaH%pz#Uy0*w$Vdl=X=rQXEzO}d6J^R6zjM1u&c9vYLvLp?W7w(?np9x1 zE_0JSAJCPB%i7p*Wvg)pn5T`8k3-uR?*NT|J`eS#_#54p>!p(mLDvmc-3o0mX*mp_ zN*AeS<>#^-{S%W<*mz^!X$w_2dHWpcJ6^j64qFBft-o}o_Vx80o0>}Du;>kLts;$8 zC`7q$QI(dKYG`Wa8#wl@V4jVWBRGQ@1dr-hstpQL)Tl+aqVpGpbSfN>5i&QMXfiZ> zaA?T1VGe?rpQ@;+pkrVdd{klI&jVS@I5_iz!=UMpTsa~mBga?1r}aRBm1WS;TT*s0f0lY=JBl66Upy)-k4J}lh=P^8(SXk~0xW=T9v*B|gzIhN z>qsO7dFd~mgxAy4V?&)=5ieYq?zi?ZEoj)&2o)RLy=@hbCRcfT5jigwtQGE{L*8<@Yd{zg;CsL5mvzfDY}P-wos_6PfprFVaeqNE%h zKZhLtcQld;ZD+>=nqN~>GvROfueSzJD&BE*}XfU|H&(FssBqY=hPCt`d zH?@s2>I(|;fcW&YM6#V#!kUIP8$Nkdh0A(bEVj``-AAyYgwY~jB zT|I7Bf@%;7aL7Wf4dZ%VqF$eiaC38OV6oy3Z#TER2G+fOCd9Iaoy6aLYbPTN{XRPz z;U!V|vBf%H!}52L2gH_+j;`bTcQRXB+y9onc^wLm5wi3-Be}U>k_u>2Eg$=k!(l@I zcCg+flakT2Nej3i0yn+g+}%NYb?ta;R?(g5SnwsQ49U8Wng8d|{B+lyRcEDvR3+`O{zfmrmvFrL6acVP%yG98X zo&+VBg@px@i)%o?dG(`T;n*$S5*rnyiR#=wW}}GsAcfyQpE|>a{=$Hjg=-*_K;UtD z#z-)AXwSRY?OPefw^iI+ z)AXz#PfEjlwTes|_{sB?4(O@fg0AJ^g8gP}ex9Ucf*@_^J(s_5jJV}c)s$`Myn|Kd z$6>}#q^n{4vN@+Os$m7KV+`}c%4)4pv@06af4-x5#wj!KKb%caK{A&Y#Rfs z-po?Dcb1({W=6FKIUirH&(yg=*6aLCekcKwyfK^JN5{wcA3nhO(o}SK#!CINhI`-I z1)6&n7O&ZmyFMuNwvEic#IiOAwNkR=u5it{B9n2sAJV5pNhar=j5`*N!Na;c7g!l$ z3aYBqUkqqTJ=Re-;)s!EOeij=7SQZ3Hq}ZRds%IM*PtM$wV z@;rlc*NRK7i3y5BETSKuumEN`Xu_8GP1Ri=OKQ$@I^ko8>H6)4rjiG5{VBM>B|%`&&s^)jS|-_95&yc=GqjNo{zFkw%%HHhS~e=s zD#sfS+-?*t|J!+ozP6KvtOl!R)@@-z24}`9{QaVLD^9VCSR2b`b!KC#o;Ki<+wXB6 zx3&O0LOWcg4&rv4QG0)4yb}7BFSEg~=IR5#ZRj8kg}dS7_V&^%#Do==#`u zpy6{ox?jWuR(;pg+f@mT>#HGWHAJRRDDDv~@(IDw&R>9643kK#HN`!1vBJHnC+RM&yIh8{gG2q zA%e*U3|N0XSRa~oX-3EAneep)@{h2vvd3Xvy$7og(sayr@95+e6~Xvi1tUqnIxoIH zVWo*OwYElb#uyW{Imam6f2rGbjR!Y3`#gPqkv57dB6K^wRGxc9B(t|aYDGS=m$&S!NmCtrMMaUg(c zc2qC=2Z`EEFMW-me5B)24AqF*bV5Dr-M5ig(l-WPS%CgaPzs6p_gnCIvTJ=Y<6!gT zVt@AfYCzjjsMEGi=rDQHo0yc;HqoRNnNFeWZgcm?f;cp(6CNylj36DoL(?TS7eU#+ z7&mfr#y))+CJOXQKUMZ7QIdS9@#-}7y2K1{8)cCt0~-X0O!O?Qx#E4Og+;A2SjalQ zs7r?qn0H044=sDN$SRG$arw~n=+T_DNdSrarmu)V6@|?1-ZB#hRn`uilTGPJ@fqEy zGt(f0B+^JDP&f=r{#Y_wi#AVDf-y!RIXU^0jXsFpf>=Ji*TeqSY!H~AMbJdCGLhC) zn7Rx+sXw6uYj;WRYrLd^5IZq@6JI1C^YkgnedZEYy<&4(z%Q$5yv#Boo{AH8n$a zhb4Y3PWdr269&?V%uI$xMcUrMzl=;w<_nm*qr=c3Rl@i5wWB;e-`t7D&c-mcQl7x! zZWB`UGcw=Y2=}~wzrfLx=uet<;m3~=8I~ZRuzvMQUQdr+yTV|ATf1Uuomr__nDf=X zZ3WYJtHp_ri(}SQAPjv+Y+0=fH4krOP@S&=zZ-t1jW1o@}z;xk8 z(Nz1co&El^HK^NrhVHa-_;&88vTU>_J33=%{if;BEY*J#1n59=07jrGQ#IP>@u#3A z;!q+E1Rj3ZJ+!4bq9F8PXJ@yMgZL;>&gYA0%_Kbi8?S=XGM~dnQZQ!yBSgcZhY96H zrWnU;k)qy`rX&&xlDyA%(a1Hhi5CWkmg(`Gb%m(HKi-7Z!LKGRP_B8@`7&hdDy5n= z`OIxqxiVfX@OX1p(mQu>0Ai*v_cTMiw4qRt3~NBvr9oBy0)r>w3p~V0SCm=An6@3n)>@z!|o-$HvDK z|3D2ZMJkLE5loMKl6R^ez@Zz%S$&mbeoqH5`Bb){Ei21q&VP)hWS2tjShfFtGE+$z zzCR$P#uktu+#!w)cX!lWN1XU%K-r=s{|j?)Akf@q#3b#{6cZCuJ~gCxuMXRmI$nGtnH+-h z+GEi!*X=AP<|fG`1>MBdTb?28JYc=fGvAi2I<$B(rs$;eoJCyR6_bc~p!XR@O-+sD z=eH`-ye})I5ic1eL~TDmtfJ|8`0VJ*Yr=hNCd)G1p2MMz4C3^Mj?7;!w|Ly%JqmuW zlIEW^Ft%z?*|fpXda>Jr^1noFZEwFgVV%|*XhH@acv8rdGxeEX{M$(vG{Zw+x(ei@ zmfXb22}8-?Fi`vo-YVrTH*C?a8%M=Hv9MqVH7H^J$KsD?>!SFZ;ZsvnHr_gn=7acz z#W?0eCdVhVMWN12VV^$>WlQ?f;P^{(&pYTops|btm6aj>_Uz+hqpGwB)vWp0Cf5y< zft8-je~nn?W11plq}N)4A{l8I7$!ks_x$PXW-2XaRFswX_BnF{R#6YIwMhAgd5F9X zGmwdadS6(a^fjHtXg8=l?Rc0Sm%hk6E9!5cLVloEy4eh(=FwgP`)~I^5~pBEWo+F6 zSf2ncyMurJN91#cJTy_u8Y}@%!bq1RkGC~-bV@SXRd4F{R-*V`bS+6;W5vZ(&+I<9$;-V|eNfLa5n-6% z2(}&uGRF;p92eS*sE*oR$@pexaqr*meB)VhmIg@h{uzkk$9~qh#cHhw#>O%)b@+(| z^IQgqzuj~Sk(J;swEM-3TrJAPCq9k^^^`q{IItKBRXYe}e0Tdr=Huf7da3$l4PdpwWDop%^}n;dD#K4s#DYA8SHZ z&1!riV4W4R7R#C))JH1~axJ)RYnM$$lIR%6fIVA@zV{XVyx}C+a-Dt8Y9M)^KU0+H zR4IUb2CJ{Hg>CuaXtD50jB(_Tcx=Z$^WYu2u5kubqmwp%drJ6 z?Fo40g!Qd<-l=TQxqHEOuPX0;^z7iX?Ke^a%XT<13TA^5`4Xcw6D@Ur&VT&CUe0d} z1GjOVF1^L@>O)l@?bD~$wzgf(nxX1OGD8fEV?TdJcZc2KoUe|oP1#=$$7ee|xbY)A zDZq+cuTpc(fFdj^=!;{k03C69lMQ(|>uhRfRu%+!k&YOi-3|1QKB z z?n?eq1XP>p-IM$Z^C;2L3itnbJZAip*Zo0aw2bs8@(s^~*8T9go!%dHcAz2lM;`yp zD=7&xjFV$S&5uDaiScyD?B-i1ze`+CoRtz`Wn+Zl&#s4&}MO{@N!ufrzjG$B79)Y2d3tBk&)TxUTw@QS0TEL_?njX|@vq?Uz(nBFK5Pq7*xj#u*R&i|?7+6# z+|r_n#SW&LXhtheZdah{ZVoqwyT{D>MC3nkFF#N)xLi{p7J1jXlmVeb;cP5?e(=f# zuT7fvjSbjS781v?7{)-X3*?>tq?)Yd)~|1{BDS(pqC zC}~H#WXlkUW*H5CDOo<)#x7%RY)A;ShGhI5s*#cRDA8YgqG(HeKDx+#(ZQ?386dv! zlXCO)w91~Vw4AmOcATuV653fa9R$fyK8ul%rG z-wfS zihugoZyr38Im?Zuh6@RcF~t1anQu7>#lPpb#}4cOA!EM11`%f*07RqOVkmX{p~KJ9 z^zP;K#|)$`^Rb{rnHGH{~>1(fawV0*Z#)}M`m8-?ZJV<+e}s9wE# z)l&az?w^5{)`S(%MRzxdNqrs1n*-=jS^_jqE*5XDrA0+VE`5^*p3CuM<&dZEeCjoz zR;uu_H9ZPZV|fQq`Cyw4nscrVwi!fE6ciMmX$!_hN7uF;jjKG)d2@aC4ropY)8etW=xJvni)8eHi`H$%#zn^WJ5NLc-rqk|u&&4Z6fD_m&JfSI1Bvb?b<*n&sfl0^t z=HnmRl`XrFvMKB%9}>PaA`m-fK6a0(8=qPkWS5bb4=v?XcWi&hRY?O5HdulRi4?fN zlsJ*N-0Qw+Yic@s0(2uy%F@ib;GjXt01Fmx5XbRo6+n|pP(&nodMoap^z{~q ziEeaUT@Mxe3vJSfI6?uLND(CNr=#^W<1b}jzW58bIfyWTDle$mmS(|x-0|2UlX+9k zQ^EX7Nw}?EzVoBfT(-LT|=9N@^hcn-_p&sqG z&*oVs2JSU+N4ZD`FhCAWaS;>|wH2G*Id|?pa#@>tyxX`+4HyIArWDvVrX)2WAOQff z0qyHu&-S@i^MS-+j--!pr4fPBj~_8({~e1bfcl0wI1kaoN>mJL6KUPQm5N7lB(ui1 zE-o%kq)&djzWJ}ob<-GfDlkB;F31j-VHKvQUGQ3sp`CwyGJk_i!y^sD0fqC@$9|jO zOqN!r!8-p==F@ZVP=U$qSpY(gQ0)59P1&t@y?5rvg<}E+GB}26NYPp4f2YFQrQtot5mn3wu_qprZ=>Ig-$ zbW26Ws~IgY>}^5w`vTB(G`PTZaDiGBo5o(tp)qli|NeV( z@H_=R8V39rt5J5YB2Ky?4eJJ#b`_iBe2ot~6%7mLt5t8Vwi^Jy7|jWXqa3amOIoRb zOr}WVFP--DsS`1WpN%~)t3R!arKF^Q$e12KEqU36AWwnCBICpH4XCsfnyrHr>$I$4 z!DpKX$OKLWarN7nv@!uIA+~RNO)l$$w}p(;b>mx8pwYvu;dD_unryX_NhT8*Tj>BTrTTL&!?O+%Rv;b?B??gSzdp?6Uug9{ zd@V08Z$BdI?fpoCS$)t4mg4rT8Q_I}h`0d-vYZ^|dOB*Q^S|xqTV*vIg?@fVFSmMpaw0qtTRbx} z({Pg?#{2`sc9)M5N$*N|4;^t$+QP?#mov zGVC@I*lBVrOU-%2y!7%)fAKjpEFsgQc4{amtiHb95KQEwvf<(3T<9-Zm$xIew#P22 zc2Ix|App^>v6(3L_MCU0d3W##AB0M~3D00EWoKZqsJYT(#@w$Y_H7G22M~ApVFTRHMI_3be)Lkn#0F*V8Pq zc}`Cjy$bE;FJ6H7p=0y#R>`}-m4(0F>%@P|?7fx{=R^uFdISRnZ2W_xQhD{YuR3t< z{6yxu=4~JkeA;|(J6_nv#>Nvs&FuLA&PW^he@t(UwFFE8)|a!R{`E`K`i^ZnyE4$k z;(749Ix|oi$c3QbEJ3b~D_kQsPz~fIUKym($a_7dJ?o+40*OLl^{=&oq$<#Q(yyrp z{J-FAniyAw9tPbe&IhQ|a`DqFTVQGQ&Gq3!C2==4x{6EJwiPZ8zub-iXoUtkJiG{} zPaR&}_fn8_z~(=;5lD-aPWD3z8PZS@AaUiomF!G8I}Mf>e~0g#BelA-5#`cj;O5>N Xviia!U7SGha1wx#SCgwmn*{w2TRX*I literal 0 HcmV?d00001 diff --git a/stock_measuring_device_zippcube/static/description/index.html b/stock_measuring_device_zippcube/static/description/index.html new file mode 100644 index 000000000..a9f555f71 --- /dev/null +++ b/stock_measuring_device_zippcube/static/description/index.html @@ -0,0 +1,462 @@ + + + + + + +Stock Zippcube + + + +
+

Stock Zippcube

+ + +

Alpha License: AGPL-3 OCA/stock-logistics-warehouse Translate me on Weblate Try me on Runbot

+

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

+
+

Table of contents

+ +
+

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. +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.

+

Do not contact contributors directly about support or help with technical issues.

+
+
+

Credits

+
+

Authors

+
    +
  • Camptocamp
    • +
+
+
+

Contributors

+ +
+
+

Maintainers

+

This module is maintained by the OCA.

+Odoo Community Association +

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.

+

Current maintainer:

+

gurneyalex

+

This module is part of the OCA/stock-logistics-warehouse project on GitHub.

+

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

+
+
+
+ + diff --git a/stock_measuring_device_zippcube/tests/__init__.py b/stock_measuring_device_zippcube/tests/__init__.py new file mode 100644 index 000000000..93874ddcf --- /dev/null +++ b/stock_measuring_device_zippcube/tests/__init__.py @@ -0,0 +1 @@ +from . import test_zippcube_wizard diff --git a/stock_measuring_device_zippcube/tests/test_zippcube_wizard.py b/stock_measuring_device_zippcube/tests/test_zippcube_wizard.py new file mode 100644 index 000000000..a35d64190 --- /dev/null +++ b/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, + }, + )