diff --git a/docs/_static/create_item.png b/docs/_static/create_item.png new file mode 100644 index 0000000000000000000000000000000000000000..c436d923d9349330470875d2b4120f4c6e58899c Binary files /dev/null and b/docs/_static/create_item.png differ diff --git a/docs/_static/csentry-scanner.png b/docs/_static/csentry-scanner.png new file mode 100644 index 0000000000000000000000000000000000000000..64e8b52b205d699cc5b50eb5722d8aee41b471c3 Binary files /dev/null and b/docs/_static/csentry-scanner.png differ diff --git a/docs/_static/item_created.png b/docs/_static/item_created.png new file mode 100644 index 0000000000000000000000000000000000000000..715aa1d00e1cf36ae94a03796dfdcc85cd066e4d Binary files /dev/null and b/docs/_static/item_created.png differ diff --git a/docs/_static/xenon/activate-custom-defaults.png b/docs/_static/xenon/activate-custom-defaults.png new file mode 100644 index 0000000000000000000000000000000000000000..7966ad23efad7dd678ef1fdaaeede754c6855f84 Binary files /dev/null and b/docs/_static/xenon/activate-custom-defaults.png differ diff --git a/docs/_static/xenon/daytime-mode.png b/docs/_static/xenon/daytime-mode.png new file mode 100644 index 0000000000000000000000000000000000000000..18ded2d087cbf0b707aabc07bbe380e1063cb7fa Binary files /dev/null and b/docs/_static/xenon/daytime-mode.png differ diff --git a/docs/_static/xenon/hand-held-scanning.png b/docs/_static/xenon/hand-held-scanning.png new file mode 100644 index 0000000000000000000000000000000000000000..0e23c0f664336180d02d8cae431f420dd77ef2a6 Binary files /dev/null and b/docs/_static/xenon/hand-held-scanning.png differ diff --git a/docs/_static/xenon/rs232-interface.png b/docs/_static/xenon/rs232-interface.png new file mode 100644 index 0000000000000000000000000000000000000000..637e828b5ff149a1ca727befaebc78aea1546d7a Binary files /dev/null and b/docs/_static/xenon/rs232-interface.png differ diff --git a/docs/_static/xenon/silent-mode-with-flashing-led.png b/docs/_static/xenon/silent-mode-with-flashing-led.png new file mode 100644 index 0000000000000000000000000000000000000000..dd81eafc436de1ec46ab7eeeb040932445816f11 Binary files /dev/null and b/docs/_static/xenon/silent-mode-with-flashing-led.png differ diff --git a/docs/_static/xenon/usb-keyboard-mac.png b/docs/_static/xenon/usb-keyboard-mac.png new file mode 100644 index 0000000000000000000000000000000000000000..7c0e592d8ad6da50831feab11ca5d7a1796b142f Binary files /dev/null and b/docs/_static/xenon/usb-keyboard-mac.png differ diff --git a/docs/_static/xenon/usb-keyboard-pc.png b/docs/_static/xenon/usb-keyboard-pc.png new file mode 100644 index 0000000000000000000000000000000000000000..0b07645cfadd09b51db53a2a1e2bfe89ff83a9d9 Binary files /dev/null and b/docs/_static/xenon/usb-keyboard-pc.png differ diff --git a/docs/_static/xenon/usb-serial.png b/docs/_static/xenon/usb-serial.png new file mode 100644 index 0000000000000000000000000000000000000000..5cb1ffa7bb2ba96bb987e9c15b95e126ef077727 Binary files /dev/null and b/docs/_static/xenon/usb-serial.png differ diff --git a/docs/inventory.rst b/docs/inventory.rst index a8412d73aeb3f5d82769421fe3ed6ca7048d0730..26d7737965de4ac72b756615eec8795b27fdba5e 100644 --- a/docs/inventory.rst +++ b/docs/inventory.rst @@ -37,3 +37,86 @@ Clicking on the **ICS id** of an item will take you to the *View item* page. On that page you can see all the item's details. You can add comments or edit the item. + +Register a new item +------------------- + +Click on *Register new item*. You need to enter at least an **ICS id** and **serial number**. + +.. image:: _static/create_item.png + +Click on *Submit* to create the new item: + +.. image:: _static/item_created.png + +Note that the last chosen attributes (*Manufacturer*, *Model*, *Location*, *Status*) are saved to the session. +This makes it easy to enter several identical items. You can click on the *Clear* button to clear all the attributes. + +To register new items, you can scan directly the **ICS id** and **serial number** in the web UI. +See :ref:`scanner-setup` to configure the scanner as a keyboard: + +1. When the page loads, the focus is on the **ICS id** field. + Scan a label. It will set the focus on the **serial number** field. + +2. Scan a serial number. The focus will be set on the **Submit** button. + +3. Scan the *Submit* QRCode on the right of the page. This will submit the form. + + +For more complex workflows, you can use the *cse-scan* application. You should configure the scanner as a RS232-based COM port. + +.. image:: _static/csentry-scanner.png + + +.. _scanner-setup: + +Scanner setup +------------- + +Scan the following codes to change the Xenon 1900 scanner settings: + +1. Activate the default settings: + + .. image:: _static/xenon/activate-custom-defaults.png + :align: center + +2. Optimize the scanner to read bar codes from mobile phone or other LED displays: + + .. image:: _static/xenon/hand-held-scanning.png + :align: center + +3. Lower or disable the sound. Use one of the following codes: + + - Daytime Mode (all sounds to on, but to a low volume) + + .. image:: _static/xenon/daytime-mode.png + :align: center + + - Silent Mode With Flashing LED (all sounds are silenced) + + .. image:: _static/xenon/silent-mode-with-flashing-led.png + :align: center + +4. Scan directly in the web UI. Use one of the following codes: + + - USB keyboard (PC) + + .. image:: _static/xenon/usb-keyboard-pc.png + :align: center + + - USB keyboard (Mac) + + .. image:: _static/xenon/usb-keyboard-mac.png + :align: center + +5. Use csentry-scanner application. Use both following codes: + + - RS232 Interface + + .. image:: _static/xenon/rs232-interface.png + :align: center + + - USB Serial + + .. image:: _static/xenon/usb-serial.png + :align: center