[16.0][IMP] stock_barcodes: Readme

OCA · Feb 4, 2025 · 2bd5dcc · 2bd5dcc
1 parent f8b88ec
commit 2bd5dcc
Show file tree

Hide file tree

Showing 21 changed files with 459 additions and 27 deletions.
diff --git a/stock_barcodes/README.rst b/stock_barcodes/README.rst
@@ -7,7 +7,7 @@ Stock Barcodes
    !! This file is generated by oca-gen-addon-readme !!
    !! changes will be overwritten.                   !!
    !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
-   !! source digest: sha256:49485ba279bc9229b3c3abe1902c98438ef1257e130fa63c03b0f0611e5c017f
+   !! source digest: sha256:e7ccaa03134ef9bad1cb0e83f96ba7617e6ff97f7b09ded6510b4c5a74404a79
    !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
 
 .. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
@@ -36,7 +36,7 @@ other modules.
 This module also makes use of this wizard for providing barcode support for
 doing inventories and picking operations.
 
-This module allows reading barcodes from barcode actions to go directly to said actions.
+This module provides configuring barcodes for barcode actions.
 
 
 
@@ -51,13 +51,74 @@ Usage
 Barcode interface for inventory operations
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-To use the barcode interface on inventory:
+Option 1: To use the barcode interface on inventory
+
+  #. Go to *Inventory > operations > Inventory Adjustments*.
+  #. Create new inventory with "Select products manually" option.
+  #. Start inventory.
+  #. Click to "Scan barcodes" smart button.
+  #. Start reading barcodes.
+
+Option 2: Use the barcode interface inventory directly from the Barcodes application
+  #. Go to *Barcodes*.
+  #. Select the *Inventory* option.
+
+    .. image:: https://raw.githubusercontent.com/stock_barcodes/static/src/img/inventory_barcode_action.png
+       :height: 100
+       :width: 200
+       :alt: Inventory barcode action
+
+  #. Start scanning barcodes.
+
+Actions
+  # Press the *+ Product* button to display the form for the new item.
+
+    .. image:: https://raw.githubusercontent.com/stock_barcodes/static/src/img/add_product.png
+       :height: 100
+       :width: 200
+       :alt: Add product
+
+  # When you select a product, a numeric field is displayed to add the quantity.
+
+    .. image:: https://raw.githubusercontent.com/stock_barcodes/static/src/img/form_add_product_quantity.png
+       :height: 100
+       :width: 200
+       :alt: Add quantity product
+
+  # When you press the button with the trash can icon, the values of the form are reset (except for the location) without closing it.
+
+    .. image:: https://raw.githubusercontent.com/stock_barcodes/static/src/img/form_add_product_reset.png
+       :height: 100
+       :width: 200
+       :alt: Reset data form
+
+  # When you press the *Clean values* button, all fields are reset and the form is closed.
+  # When you press the *Confirm* button, the new item is added and the form is closed.
+  # When the eye icon is closed, the created items greater than zero are displayed, and if not, those less than or equal to zero.
+
+    .. image:: https://raw.githubusercontent.com/stock_barcodes/static/src/img/list_items.png
+       :height: 100
+       :width: 200
+       :alt: Reset data form
+
+  # In the list, the trash can icon allows you to reset the quantity to zero and the edit icon allows you to change the item values.
+
+    .. image:: https://raw.githubusercontent.com/stock_barcodes/static/src/img/list_action_items.png
+       :height: 100
+       :width: 200
+       :alt: Reset data form
+
+  # The *Apply* button is only displayed if there are items with quantities greater than zero, regardless of whether they were scanned or entered manually; If you press all the defined quantities will be processed after defining the reason for the inventory adjustment and then the main barcode menu will be displayed.
+
+    .. image:: https://raw.githubusercontent.com/stock_barcodes/static/src/img/apply_inventory.png
+       :height: 100
+       :width: 200
+       :alt: Apply inventory
+    .. image:: https://raw.githubusercontent.com/stock_barcodes/static/src/img/apply_inventory_reason.png
+       :height: 100
+       :width: 200
+       :alt: Apply inventory reason
 
-#. Go to *Inventory > operations > Inventory Adjustments*.
-#. Create new inventory with "Select products manually" option.
-#. Start inventory.
-#. Click to "Scan barcodes" smart button.
-#. Start reading barcodes.
 
 Barcode interface for picking operations
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -71,11 +132,109 @@ To use the barcode interface on picking operations:
 #. Click on scanner button on any operation type.
 #. Start reading barcodes.
 
-To use the barcode interface on a picking:
+Option 1: To use the barcode interface on a picking:
 
-#. Go to *Inventory > Transfers*.
-#. Click to "Scan barcodes" smart button.
-#. Start reading barcodes.
+  #. Go to *Inventory > Transfers*.
+  #. Click to "Scan barcodes" smart button.
+  #. Start reading barcodes.
+
+Option 2: Use the barcode interface picking directly from the Barcodes application
+  #. Go to *Barcodes*.
+  #. Select the option *OPERATIONS*.
+
+    .. image:: https://raw.githubusercontent.com/stock_barcodes/static/src/img/inventory_barcode_action.png
+       :height: 100
+       :width: 200
+       :alt: Operation barcode action
+
+  # Select the type of picking.
+  # The pickings in ready status are displayed, select the one you want to start scanning.
+
+    .. image:: https://raw.githubusercontent.com/stock_barcodes/static/src/img/list_picking.png
+       :height: 100
+       :width: 200
+       :alt: List picking
+
+  #. Start scanning barcodes.
+
+    .. image:: https://raw.githubusercontent.com/stock_barcodes/static/src/img/barcode_interface_picking.png
+       :height: 100
+       :width: 200
+       :alt: List picking
+
+Actions
+  # All the items that have been configured for the selected picking are listed.
+
+    .. image:: https://raw.githubusercontent.com/stock_barcodes/static/src/img/list_items_picking.png
+       :height: 100
+       :width: 200
+       :alt: List picking
+
+  # The edit icon in the list allows you to modify the data.
+
+    .. image:: https://raw.githubusercontent.com/stock_barcodes/static/src/img/list_items_picking_edit.png
+       :height: 100
+       :width: 200
+       :alt: Edit picking
+
+  # The button that contains a *+120* (in this case), allows you to define all the
+    remaining quantities. Once defined, this button disappears and if you want to change the
+    quantities, press the edit button.
+
+    .. image:: https://raw.githubusercontent.com/stock_barcodes/static/src/img/list_items_picking_quantity.png
+       :height: 100
+       :width: 200
+       :alt: Quantity picking
+
+  # If there is at least one item with a quantity already defined, an eye icon is displayed,
+    which if closed shows the items and their quantities already scanned.
+
+    .. image:: https://raw.githubusercontent.com/stock_barcodes/static/src/img/list_items_picking_scanned.png
+       :height: 100
+       :width: 200
+       :alt: Picking scanned
+
+  # When you press the *Validate* button, a wizard will be displayed to confirm the action.
+    If everything is correct, it is validated and you return to the picking list mentioned above.
+
+    .. image:: https://raw.githubusercontent.com/stock_barcodes/static/src/img/confirm_items_picking.png
+       :height: 100
+       :width: 200
+       :alt: Picking scanned
+
+  # If there is an item whose quantity is zero, a wizard will be displayed after the one mentioned
+    above, to confirm if you want to process all the quantities. If positive, you will proceed
+    and be directed to the list mentioned above in the previous point.
+
+    .. image:: https://raw.githubusercontent.com/stock_barcodes/static/src/img/confirm_all_quantity_items_picking.png
+       :height: 100
+       :width: 200
+       :alt: Picking scanned
+
+  # Press the *+ Product* button to display the form for the new item.
+
+    .. image:: https://raw.githubusercontent.com/stock_barcodes/static/src/img/add_product.png
+       :height: 100
+       :width: 200
+       :alt: Add product
+
+  # When you select a product, a numeric field is displayed to add the quantity.
+
+    .. image:: https://raw.githubusercontent.com/stock_barcodes/static/src/img/form_add_product_quantity.png
+       :height: 100
+       :width: 200
+       :alt: Add quantity product
+
+  # When you press the button with the trash can icon, the values of the form are reset (except for the location) without closing it.
+
+    .. image:: https://raw.githubusercontent.com/stock_barcodes/static/src/img/form_add_product_reset.png
+       :height: 100
+       :width: 200
+       :alt: Reset data form
+
+  # When you press the *Clean values* button, all fields are reset and the form is closed.
+  # When you press the *Confirm* button, the new item is added and the form is closed.
+  # When adding the new item all the quantities are assigned to it, if you want to modify it, press the edit icon.
 
 The barcode scanner interface has two operation modes. In both of them user
 can scan:

diff --git a/stock_barcodes/readme/DESCRIPTION.rst b/stock_barcodes/readme/DESCRIPTION.rst
@@ -6,6 +6,6 @@ other modules.
 This module also makes use of this wizard for providing barcode support for
 doing inventories and picking operations.
 
-This module allows reading barcodes from barcode actions to go directly to said actions.
+This module provides configuring barcodes for barcode actions.