Skip to content

Commit

Permalink
Docs upd. missed params.
Browse files Browse the repository at this point in the history
  • Loading branch information
TAHRI Ahmed committed Oct 2, 2017
1 parent a9e6120 commit f4dc37f
Show file tree
Hide file tree
Showing 3 changed files with 32 additions and 2 deletions.
18 changes: 16 additions & 2 deletions docs/classes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,7 @@ Device management

.. class:: Telium

.. method:: __init__(path='/dev/ttyACM0', baudrate=9600, timeout=1)
.. method:: __init__(path='/dev/ttyACM0', baudrate=9600, timeout=1, open_on_create=True, debugging=False)

:param path:
Device path.
Expand All @@ -163,7 +163,13 @@ Device management
:param float timeout:
Set a read timeout value.

The port is immediately opened on object creation.
:param bool open_on_create:
Specify if device should be immedialty opened on instance creation.

:param bool debugging:
Set it to True if you want to diagnose your device. Will print to stdout bunch of useful data.

The port is immediately opened on object creation if open_on_create toggle is True.

*path* is the device path: depending on operating system. e.g.
``/dev/ttyACM0`` on GNU/Linux or ``COM3`` on Windows. Please be aware
Expand Down Expand Up @@ -217,3 +223,11 @@ Device management

:getter: Current timeout set on read.
:type: float


Native serial proxy class
-------------------------

*Use this class instead of Telium if you're using native serial conn, see examples.*

.. class:: TeliumNativeSerial
15 changes: 15 additions & 0 deletions docs/examples.rst
Original file line number Diff line number Diff line change
Expand Up @@ -44,3 +44,18 @@ Create instance::
collect_payment_source_info=True, # If you need to identify payment source
force_bank_verification=False # Set it to True if you absolutly need more guarantee in this transaction. Could result in slower authorization from bank.
)

Use Ingenico payment device thought not emulated serial link
------------------------------------------------------------

.. image:: https://pmcdn.priceminister.com/photo/ingenico-sagem-cable-liaison-1m-vers-pc-ou-caisse-rs232-femelle-et-rj11-1033614629_ML.jpg
:height: 200px
:width: 300px
:scale: 50 %
:alt: Ingenico RS 232 Cable
:align: left

Init::

# It's as easy as this
my_device = TeliumNativeSerial('/dev/ttyS4')
1 change: 1 addition & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ Overview
========

This module allow you to manipulate your Ingenico payment device such as IWL250, iCT250 for instance.
Accept USB Emulated Serial Device or Native RS-232 Serial Link.

.. image:: http://www.vente-terminal-de-paiement.com/wp-content/uploads/2015/07/iwl250-inthehand-fr.jpg
:height: 400px
Expand Down

0 comments on commit f4dc37f

Please sign in to comment.