[IMP] point_of_sale: add Cashdro cash machine docs#17119
[IMP] point_of_sale: add Cashdro cash machine docs#17119MaxTheWhale wants to merge 1 commit into19.0from
Conversation
|
|
emmi-odoo
left a comment
emmi-odoo
left a comment
There was a problem hiding this comment.
Hey @MaxTheWhale! Thank you for adding this documentation page! Here are some comments and suggestions in order to align with the requirements of this documentation section ;)
|
|
||
| Cash machine settings | ||
| --------------------- | ||
|
|
There was a problem hiding this comment.
I would add a short introduction here to briefly explain that setting up the cash machine requires locating the IP address (which is going to be used when creating a payment method; so I would add a ref to the Payment method section of this page), and enabling HTTP (briefly mention why it's also important).
| #. Find the IP address of the Cashdro machine. | ||
|
|
||
| - By default, the cash machine simply displays the Cashdro logo with no other information. In order to | ||
| see the IP address, you can temporarily remove one of the devices inside the machine. This will | ||
| cause a diagnostics screen to appear which shows the IP address. Ensure the device is reconnected after | ||
| the IP address has been noted down. | ||
| - The IP address should be static to ensure long term stable operation. |
There was a problem hiding this comment.
Since there aren't many steps for this action, I suggest making this a paragraph:
"To locate the Cashdro machine's IP address, remove one of the devices (we'll need a clear example) inside the machine. This action displays a diagnostics screen with the IP address. Keep the IP address for the :ref:payment method process <create a ref for the payment method section> and make sure to reconnect the device."
Then, I would put this part "The IP address should be static to ensure long-term stable operation." in the Note.
| - Login as the support user. | ||
| - Navigate to :menuselection:`Configuration --> General parameters`. | ||
| - In the :guilabel:`Web Integration` section, ensure :guilabel:`Enable HTTP` is checked. | ||
| - Restart the machine. |
There was a problem hiding this comment.
Since there seems to be an order to follow, I'd make a proper numbered list:
"To enable the HTTP setting on the Cashdro machine, follow the next steps:
- Navigate to the login screen at
https://<cashdro-ip>/Cashdro3Web/#/login. - Log in as the support user.
- Navigate to :menuselection:
Configuration --> General parameters. - Check :guilabel:
Enable HTTPin the :guilabel:Web Integrationsection. - Restart the machine."
There was a problem hiding this comment.
This comment concerns lines R27 to R33
|
|
||
| .. _pos/cashdro/configuration: | ||
|
|
||
| Configuration |
There was a problem hiding this comment.
Since the Configuration section is the only h2 in this doc, I suggest removing it and turning the h3 into h2, i.e., Cash machine settings (and maybe turn it into Cash machine configuration - to your own preference, of course) and Payment method.
| .. note:: | ||
| This setup is technical and requires knowing the admin password of the Cashdro hardware. It is advisable to | ||
| consult the Cashdro integration partner for configuration if there is any uncertainty. |
There was a problem hiding this comment.
As this is quite important information, I'd put it right under the section title under an important banner.
| .. note:: | |
| This setup is technical and requires knowing the admin password of the Cashdro hardware. It is advisable to | |
| consult the Cashdro integration partner for configuration if there is any uncertainty. | |
| .. note:: | |
| Setting up the Cashdro machine requires the Cashdro hardware administrator password and technical knowledge. If needed, consult the Cashdro integration partner for configuration support. |
There was a problem hiding this comment.
Then, I'd replace this information in this Note banner: "The IP address should be static to ensure long-term stable operation."
| - Go to :menuselection:`Point of Sale --> Configuration --> Payment Methods`. Create a new | ||
| :guilabel:`Cash` payment method or update an existing payment method. | ||
| - Select the associated POS in the :guilabel:`Point of Sale` field. | ||
| - Select :guilabel:`Cash Machine (Cashdro)` in the :guilabel:`Integration` field. |
There was a problem hiding this comment.
| - Select :guilabel:`Cash Machine (Cashdro)` in the :guilabel:`Integration` field. | |
| #. Set the :guilabel:`Integration` field to :guilabel:`Cash Machine (Cashdro)`. |
| :guilabel:`Cash` payment method or update an existing payment method. | ||
| - Select the associated POS in the :guilabel:`Point of Sale` field. | ||
| - Select :guilabel:`Cash Machine (Cashdro)` in the :guilabel:`Integration` field. | ||
| - Fill in the :guilabel:`Cashdro IP` field with the IP address of the cash machine. |
There was a problem hiding this comment.
| - Fill in the :guilabel:`Cashdro IP` field with the IP address of the cash machine. | |
| #. Type the Cashdro machine's IP address in the :guilabel:`Cashdro IP` field. |
There was a problem hiding this comment.
Does it also occur in a "Cashdro Settings" tab like with Glory? That'd be useful to mention it as well. Something like: "Type the Cashdro machine's IP address in the :guilabel:Cashdro IP field under the :guilabel:Cashdro Settingstab.
| - Select the associated POS in the :guilabel:`Point of Sale` field. | ||
| - Select :guilabel:`Cash Machine (Cashdro)` in the :guilabel:`Integration` field. | ||
| - Fill in the :guilabel:`Cashdro IP` field with the IP address of the cash machine. | ||
| - Fill in the :guilabel:`Cashdro Username` and :guilabel:`Cashdro Password` fields with your Cashdro user credentials. |
There was a problem hiding this comment.
| - Fill in the :guilabel:`Cashdro Username` and :guilabel:`Cashdro Password` fields with your Cashdro user credentials. | |
| #. Type your Cashdro user credentials in the :guilabel:`Cashdro Username` and :guilabel:`Cashdro Password` fields. |
| - Select :guilabel:`Cash Machine (Cashdro)` in the :guilabel:`Integration` field. | ||
| - Fill in the :guilabel:`Cashdro IP` field with the IP address of the cash machine. | ||
| - Fill in the :guilabel:`Cashdro Username` and :guilabel:`Cashdro Password` fields with your Cashdro user credentials. | ||
| - Enable the :guilabel:`Cashdro Local Network Access` checkbox. |
There was a problem hiding this comment.
| - Enable the :guilabel:`Cashdro Local Network Access` checkbox. | |
| #. Enable the :guilabel:`Cashdro Local Network Access` checkbox. |
| - It is highly recommended to use this setting as it bypasses the need for an SSL certificate. See :doc:`Local Network Access <../../hardware_network/pos_lna>` | ||
| for more details. |
There was a problem hiding this comment.
This should be in a Note banner:
| - It is highly recommended to use this setting as it bypasses the need for an SSL certificate. See :doc:`Local Network Access <../../hardware_network/pos_lna>` | |
| for more details. | |
| - It is highly recommended to use the :doc:`Local Network Access <../../hardware_network/pos_lna>` setting, as it bypasses the need for an :doc:`SSL certificate <../../hardware_network/epos_ssc>`. |
MaxTheWhale
force-pushed
the
19.0-pos_cashdro-docs-mawh
branch
from
0636b96 to
362eade
Compare
Thanks for the fast and thorough review! I believe I've addressed all the comments but let me know if there is more to do :) |
MaxTheWhale
force-pushed
the
19.0-pos_cashdro-docs-mawh
branch
from
362eade to
c5904c2
Compare
This commit adds documentation on how to configure a Cashdro cash machine in the POS. There are now two cash machines supported, Glory and Cashdro. task-5355208
emmi-odoo
force-pushed
the
19.0-pos_cashdro-docs-mawh
branch
from
c5904c2 to
77b3900
Compare
emmi-odoo
left a comment
emmi-odoo
left a comment
There was a problem hiding this comment.
Hey @MaxTheWhale, thanks for the changes. I snuck into your branch to tweak some minor details. It looks good to me! @auva-odoo , could you please double-check and/or eventually r+?
3 participants
This commit adds documentation on how to configure a Cashdro cash machine in the POS. There are now two cash machines supported, Glory and Cashdro.
task-5355208