Metadata-Version: 2.1
Name: odoo-addon-stock_vertical_lift
Version: 18.0.1.1.2
Requires-Python: >=3.10
Requires-Dist: odoo-addon-stock_location_tray==18.0.*
Requires-Dist: odoo-addon-web_notify==18.0.*
Requires-Dist: odoo==18.0.*
Summary: Provides the core for integration with Vertical Lifts
Home-page: https://github.com/OCA/stock-logistics-warehouse
License: AGPL-3
Author: Camptocamp, Odoo Community Association (OCA)
Author-email: support@odoo-community.org
Classifier: Programming Language :: Python
Classifier: Framework :: Odoo
Classifier: Framework :: Odoo :: 18.0
Classifier: License :: OSI Approved :: GNU Affero General Public License v3
Classifier: Development Status :: 3 - Alpha
Description-Content-Type: text/x-rst

.. image:: https://odoo-community.org/readme-banner-image
   :target: https://odoo-community.org/get-involved?utm_source=readme
   :alt: Odoo Community Association

=============
Vertical Lift
=============

.. 
   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
   !! This file is generated by oca-gen-addon-readme !!
   !! changes will be overwritten.                   !!
   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
   !! source digest: sha256:d75e72f90b864e2ced7d834423d75273233ec35ca34492c47332be1293f41e69
   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

.. |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/license-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/18.0/stock_vertical_lift
    :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-18-0/stock-logistics-warehouse-18-0-stock_vertical_lift
    :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-logistics-warehouse&target_branch=18.0
    :alt: Try me on Runboat

|badge1| |badge2| |badge3| |badge4| |badge5|

Add configuration and dedicated screens to work with Vertical Lift
systems (such as Kardex Remstar, Modula, ...). Drivers for controlling
the lifts physically must be added by additional addons.

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

Configuration
=============

General
-------

In Inventory Settings, you must have:

   - Storage Locations
   - Multi-Warehouses
   - Multi-Step Routes

Locations
---------

Additional configuration parameters are added in Locations:

- Sub-locations of a location with the "Is a Vertical Lift View
  Location" activated are considered as "Shuttles". A shuttle is a
  vertical lift shelf.
- Sub-locations of shuttles are considered as "Trays", which is a tier
  of a shuttle. When a tray is created, a tray type must be selected.
  When saved, the tray location will automatically create as many
  sub-locations - called "Cells" - as the tray type contains.
- The tray type of a tray can be changed as long as none of its cell
  contains products. When changed, it archives the cells and creates new
  ones as configured on the new tray type.

Tray types
----------

Tray types can be configured in the Inventory settings. A tray type
defines how much cells a tray can hold. It is a square or rectangle
matrix of n cols \* m rows.

Vertical Lift Shuttles
----------------------

The Shuttles are the Vertical Lift Trays. One Shuttle entity has to be
created in Odoo for each physical shuttle. Depending of the subsidiary
addons installed (eg. Kardex), different options may be required (host
address, ...). The base addon only includes shuttles of kind
"simulation" which will not send orders to the hardware.

Put-away configuration
----------------------

If you want to use put-away in the vertical lift, the Receipts must have
the vertical lift view as destination. E.g. create put-away rules on the
products so when they arrive in WH/Stock, they are stored in
WH/Stock/Vertical Lift. On the put-away screen, when scanning the tray
type to store, the destination will be updated with an available cell of
the same tray type in the current shuttle.

Barcodes
--------

The operations allowed in the screen for the vertical lift (save,
release, skip) can be triggered using a barcode. For this, print the
barcodes contained in the folder 'images'.

Security
--------

A callback endpoint ``/vertical-lift`` is published to receive commands'
answers. To be able to call this endpoint a secret key has to be
provided in the POST request. Example data:
``{"answer": "foo", "secret": "SECRET"}``

On the server side you must configure the matching secret. There are 2
ways:

1. set a config param via "Inventory/Settings/Vertical Lift"
2. set the env var ``VERTICAL_LIFT_SECRET``

Development
===========

The barcodes used are of the type Code 128 (with the code set B).

Known issues / Roadmap
======================

- Complete screen workflows (currently enough for a demo, not for
  production)
- Inventory: find a way to have a nice autofocus for quantity, still
  compatible with barcode scanner (Odoo disables the autofocus when
  using barcode, which makes sense)
- Put-away: handle packages
- Handle "multi-shuttle" put-away
- Create glue module for product_expiry
- Challenge the save + release buttons and workflow

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 to smash it by providing a detailed and welcomed
`feedback <https://github.com/OCA/stock-logistics-warehouse/issues/new?body=module:%20stock_vertical_lift%0Aversion:%2018.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
------------

- Guewen Baconnier <guewen.baconnier@camptocamp.com>

Trobz

- Dung Tran <dungtd@trobz.com>
- Nhan Tran <nhant@trobz.com>

Other credits
-------------

The development of this module has been financially supported by:

- Camptocamp

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.

This module is part of the `OCA/stock-logistics-warehouse <https://github.com/OCA/stock-logistics-warehouse/tree/18.0/stock_vertical_lift>`_ project on GitHub.

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