| Availability |
Odoo Online
Odoo.sh
On Premise
|
| Odoo Apps Dependencies |
•
Point of Sale (point_of_sale)
• Inventory Management (stock) • Discuss (mail) |
| Lines of code | 397 |
| Technical Name |
odoo_pos_keyboard |
| License | OPL-1 |
| Versions | 11.0 12.0 13.0 |
POS Keyboard
Inspired by modal editing, and keybindings of VI for extreme productivity
POS Keyboard addon provides complete keyboard support for Oddo's POS interface. It is inspired by modal editing, and keybindings of VI. So one can perform all the standard operations efficiently with just a keyboard. It provides keyboard support for all screens, including the product screen, the payment screen, recipient screen, client screen and for the popups.
Keybindings are split into two modes named, NORMAL, and SEARCH, which each support very different actions.
NORMAL mode:
Among the actions that you could perform in the NORMAL mode:
- Insert new order
- Delete current order
- Interact with the Number-pad
- Interact with the Action-pad
- Interact with the Order Widget (eg:- Delete an order-line)
- Interact with popups
- Switch between Qty, Disc, Price
- Finalize order
- Switch to SEARCH mode
SEARCH mode:
In the the search mode, one of the text input fields will be given the focus.
Among the actions that you could perform in the SEARCH mode:
- Filter out an item out of out of all the products displayed in the product screen
- Add that item to the order
- Filter out a customer, and assign that customer to an order
- Return back to NORMAL mode
Usage
1. The Product Screen
The product screen is the default screen for orders and is the startup screen of the POS interface. It includes several sub-widgets, such as product list widget, order widget, Numpad, Actionpad and the like.
| Mode | Key | Description |
|---|---|---|
| NORMAL | ESC | Product screen opens by default in NORMAL mode. Only in NORMAL mode, that you can interact with widgets mentioned above. You can press ESC to get back from INSERT to NORMAL mode. |
| SEARCH | s | In SEARCH mode text input field named 'Search Products' will have the focus. You can filter out products that is being shown in the product list widget while in the SEARCH mode. |
1.1 SEARCH Mode
While in SEARCH mode you can filter out the products that you'd need to add to the current order.
| Action | Key | Description |
|---|---|---|
| Add item to order | ENTER | Once you filtered out single item out of out of all the products displayed in the product screen, press ENTER to add that item to the order. |
| Return to NORMAL mode | ESC | If you press ESC while search field has the focus. then the focus is lost. If you press s again, search field will regain focus. |
1.2 NORMAL Mode
Actions (not bind to any particular widget) that can be performed while in the NORMAL mode.
| Action | Key |
|---|---|
| Insert new order | INSERT |
| Destroy current order | DELETE |
| Confirm pop up | ENTER |
| Cancel pop up | ESC |
1.2.1 The Num Pad
| Action | Key | Description |
|---|---|---|
| Enter Number | 1 - 9 | |
| Delete Last Character | BACKSPACE | If qty is selected and order line shows 0 units, the selected order line will be deleted |
| Mode | Key |
|---|---|
| Qty | q or / |
| Disc | d |
| Price | p or * |
1.2.2 The Action Pad
The action pad contains the payment button and the customer selection button.
| Button | Shortcut |
|---|---|
| Customer | c |
| Payment | Enter |
1.2.3 The Order Widget
The Order Widget displays information about the current order. It can have zero or more order lines.
| Action | Key | Note |
|---|---|---|
| Change Selected Order Line | ArrowDown (j) and ArrowUp (k) | |
| Delete Last Character | BACKSPACE | Differ based on the mode being selected: Qty, Disc, Price |
| Delete Selected Order Line | r |
2. Payment Screen
The Payment Screen handles the payments, and validates the order.
| Action | Key | Description |
|---|---|---|
| Numpad Input | 1 - 9 and . | Used to enter the tendered amount in selected payment-line |
| Validate | Enter | |
| Change selected payment line | ArrowDown and ArrowUp | |
| Delete selected payment line | r | |
| Scroll payment methods view | j and k | Only useful if there are several payment methods |
| Set customer | c | You will be prompt with the client list screen, where you could assign a customer for the order |
| Go back to the product screen | ESC |
3. The Receipt Screen
This displays the order's receipt and gives an option to print it on your web browser.
| Action | Key | Description |
|---|---|---|
| Finalize the order | ENTER | Mark the current order as completed and proceed to the next |
| Print receipt | p |
4. The Client List Screen
You can use client list screen to create, edit, and to assign a customer to an order.
| Mode | Key | Description |
|---|---|---|
| SEARCH | s | Gives focus to the text input field 'Search Customers' |
| NORMAL | ESC | Client screen opens by default in NORMAL mode. You can press ESC to get back to NORMAL mode while in SEARCH mode. |
4.1 NORMAL Mode
| Action | Key | Description |
|---|---|---|
| Switch to SEARCH mode | s | Gives focus to the text input field 'Search Customers' |
| Add new customer | a | |
| Cancel | ESC | Return back to the previous screen |
| DESELECT customer | ENTER | Only visible if a customer is already being selected |
| Edit selected customer | e | Only visible if a customer is already being selected |
4.2 SEARCH Mode
In SEARCH mode the text input field 'Search Customers' is given the focus, and you can use it to filter out a customer that you'd need to assign to the current order. Once a single customer being filtered out from the list, press ENTER to assign that customer to the current order.
| Action | Key | Description |
|---|---|---|
| SELECT CUSTOMER | ENTER | Pressing ENTER will select the filtered customer out of all the customers displayed in the client screen. |
| Return to NORMAL mode | ESC | If you press ESC while search field has the focus. then the focus is lost. |
5. The Client Details Screen
The UI to add, update customer information. You can use usual shift, and shift + tab keys to move between input fields, forward and backward respectively.
| Action | Key | Description |
|---|---|---|
| Save customer details | ENTER | If any of input fields have the focus, first press ESC to switch to NORMAL mode. Then press ENTER to save the changes being made. |
Support
Want to request a feature, or report a bug? Just open an issue in our public issue tracker. No registration is required.
Odoo Proprietary License v1.0 This software and associated files (the "Software") may only be used (executed, modified, executed after modifications) if you have purchased a valid license from the authors, typically via Odoo Apps, or if you have received a written agreement from the authors of the Software (see the COPYRIGHT file). You may develop Odoo modules that use the Software as a library (typically by depending on it, importing it and using its resources), but without copying any source code or material from the Software. You may distribute those modules under the license of your choice, provided that this license is compatible with the terms of the Odoo Proprietary License (For example: LGPL, MIT, or proprietary licenses similar to this one). It is forbidden to publish, distribute, sublicense, or sell copies of the Software or modified copies of the Software. The above copyright notice and this permission notice must be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Please log in to comment on this module
Report comment
Any abuse of this reporting system will be penalizedThere are no ratings yet!
compatibility with barcode reader
Hi, I want to know if this module works without problems in parallel with the barcode reader?
Re: compatibility with barcode reader
Yes, it should work along with any barcode reader modules.