wizarPOS - User contributions [en]

MDB Communication Protocal

2022-07-22T10:59:13Z

Xuyin:

== Introduction ==
This doc defines a serial communication protocol between the application running on Q3v and MDB Vending machine.
Overall,the q3v low level hardware will forwarding the mdb request from the vendg machine,and forward to the Android application as serial data,
When the app tackle all the request serial data, the q3v pos could be regarded as a MDB cashless slave device.
And also,the application could request some config command, e.g. "get firmware version",Therefore the protocol is 2-way-direction,
and there is a mode byte indicates the direction.

== Serial Protocol Packet Definition ==
=== Serial Port parameters ===
* Baud rate 115200
* 8bit, 1 stop bit, and no parity
=== Packet format ===
{| class="wikitable"
|-
| Start code || Length || mode || Data || Checksum || End code
|}
* '''Start code''' size 1 byte, always be 0x09
* '''Length''' size: 1byte, the number bytes of mode, data, and checksum.
* '''Mode''' size: 1, 0x00 means a master request packet, 0x01 means a slave response packet, other value is prohibited.
* '''Data '''size: n bytes. The data could be raw MDB commands, such as SETUP, VEND(please refer the <Multi-Drop Bus Protocol V4.3>for detials). 
Or the MIB control commands, such as GET VERSION, SET PARAMETER.
* '''Checksum''' size: 1byte, using LRC algorithm, input data were "mode, data"

== Specifics ==
=== MDB Forwarding mechanism ===
The q3v will forward all the MDB cashless device commands,except the the POLL command,the request and response procedure can be described in following steps:
# VMC Send MDB request to q3v
# q3v receive the step 1 data,get rid the 9th mdb mode bit,fill into serial packet '''data''' part,sending the serial packet to application.
# The application will listen to to the serial port all the time,after receiving step 2 serial data,unwrap it to mdb request data,handle it, and wrap its mdb response into serial packet, sending to q3v
# q3v get the step 3 data, unwrap to mdb response data, add mdb mode bit,forwarding to mdb master.
# mdb master handle the mdb slave response

Taking the '''RESET''' for example
# ''VMC -> q3v: 0x110 0x10''
# ''q3v -> app: 0x09 0x04 0x00 0x10 0x10 0xE0 0x0D''
# ''app -> q3v: 0x09 0x04 0x01 0x00 0x00 0xFF 0x0D''
# ''q3v -> VMC: 0x00 0x100''
# ''VMC -> q3v: 0x00''
=== Application notes ===
* App need to focus on step 2,3 list above
* It's application's own task to tackle all cashless command except the POLL
* When the cashless reader is ready for transaction, it lunch a '''begin session''' command,to notify the VMC
* mdb raw data including its checksum byte(try to make different with the serial frame checksum )

== A typical MDB transacrion flow ==
[[File:Mdb flow chart.png|frame|center|MDB transacrion flow]]

== Protocol command definition ==
=== common mdb forwarding command ===
'''Description:''' 

This command for forwarding the raw MDB commands (Including the
MDB CHK), Note that the MDB mode bit has been removed
{| class="wikitable"
|-
! Mode !! Data
|-
| Request 00H || VMC Request Command
(Reset,Setup,Reader,Expansion,Vend)
|}
'''Response packet''' 
{| class="wikitable"
|-
! Mode!! Data
|-
| Response 01H || Peripheral Response
|}
'''Example:''' 
q3v -> app 09 04 00 10 10 E0 0D 

q3v <- app 09 04 01 00 00 FF 0D.
=== Begin session command ===
'''Description:''' 
When app ready for transaction, it will issue a begin session command, to inform the VMC master.
it is the beginning of one transaction.
Balance amount: 2 Bytes, if balance does not exist, it should be filled with 0xFF.
This command still obeys the MDB spec definition, however it is request by app
{| class="wikitable"
|-
! Mode !! Data
|-
| Request 00H || Begin Session (03H) + Funds Available + MDB Checksum
|}
'''Response packet''' 
{| class="wikitable"
|-
! Mode!! Data
|-
| Response 01H || ACK 00H
|}
'''Example:''' 
q3v <- app 09 06 00 03 00 64 67 32 0d 

q3v -> app 09 03 01 00 ff 0d
=== session cancel request -0x04 ===
'''Description:''' 
App can end the payment session by issue a session cancel request command, pos is in master mode during the command.
{| class="wikitable"
|-
! Mode !! Data
|-
| Request 00H || Cancel Session Req(04H) + Funds Available + Checksum
|}
'''Response packet''' 
{| class="wikitable"
|-
! Mode!! Data
|-
| Response 01H || ACK 00H
|}

MDB Communication Protocal

2022-07-22T10:33:22Z

Xuyin:

MDB Communication Protocal

2022-07-22T10:24:44Z

Xuyin:

MDB Communication Protocal

2022-07-22T08:31:41Z

Xuyin:

== Introduction ==
This manual describes the serial communication protocol between Q3v and MDB Interface Board, which will be short as "MIB" in follow content.
The basic baud rate of serial port is set as 115200.
As the Q3 Pos could be receive command from MIB as a slave, and also could send command to MIB as a master (e.g., send “begin session” command to inform the MDB VMC it’s ready for pay), a mode byte was added in serial frame to show if a command is slave response or a master request.
The request command always anticipates a response command except the checksum is wrong, or the incorrect serial format, in another word, the slave will use silence as a NAK.

== Protocol Packet Definition ==
=== Serial Port parameters ===
* Baud rate 115200
* 8bit, 1 stop bit, and no parity
=== Packet format ===
{| class="wikitable"
|-
| Start code || Length || mode || Data || Checksum || End code
|}
* '''Start code''' size 1 byte, always be 0x09
* '''Length''' size: 1byte, the number bytes of mode, data, and checksum.
* '''Mode''' size: 1, 0x00 means a master request packet, 0x01 means a slave response packet, other value is prohibited.
* '''Data '''size: n bytes. The data could be raw MDB commands, such as SETUP, VEND(please refer the Multi-Drop Bus Protocol V4.3 for detials). 
Or the MIB control commands, such as GET VERSION, SET PARAMETER.
* '''Checksum''' size: 1byte, using LRC algorithm, input data were "mode, data"

== MDB Forwarding mechanism ==
MIB will forward all the MDB cashless device commands (MDB spec section 7), except VMC request Poll. 

When the MIB receive the VMC request, it removes the MDB mode bit, fill into serial packet data area, and transmit to serial port. In the opposite direction, the MIB receive the response, it unwraps the packet, and adding mode bit to the tail bytes, sending to the VMC, wait for the acknowledge. 

Taking the RESET for example, the transfer steps can be described as below.
# ''VMC -> MIB: 0x110 0x10''
# ''MIB -> Q3V: 0x09 0x04 0x00 0x10 0x10 0xE0 0x0D''
# ''VMC -> MIB: 0x00 0x100''
# ''VMC -> MIB: 0x00''

== A typical MDB transacrion flow ==
[[File:Mdb flow chart.png|thumb]]

File:Mdb flow chart.png

2022-07-22T08:31:07Z

Xuyin:

Mdb typical transaction flow chart

MDB Communication Protocal

2022-07-22T08:26:49Z

Xuyin:

MDB Communication Protocal

2022-07-22T07:51:36Z

Xuyin:

== Introduction ==
This manual describes the serial communication protocol between Q3v and MDB Interface Board, which will be short as “MIB” in follow content.
The basic baud rate of serial port is set as 115200
As the Q3 Pos could be receive command from MIB as a slave, and also could send command to MIB as a master (e.g., send “begin session” command to inform the MDB VMC it’s ready for pay), a mode byte was added in serial frame to show if a command is slave response or a master request.
The request command always anticipates a response command except the checksum is wrong, or the incorrect serial format, in another word, the slave will use silence as a NAK.
== MDB Forwarding mechanism ==
MIB will forward all the MDB cashless device commands (MDB spec section 7), except VMC request Poll.
When the MIB receive the VMC request, it removes the MDB mode bit, fill into serial packet data area, and transmit to serial port. In the opposite direction, the MIB receive the response, it unwraps the packet, and adding mode bit to the tail bytes, sending to the VMC, wait for the acknowledge.
Taking the RESET for example, the transfer data flow can be described as below.
* VMC -> MIB: 0x110 0x10
* MIB -> Q3V: 0x09 0x04 0x00 0x10 0x10 0xE0 0x0D
* MIB -> Q3V: 0x09 0x04 0x01 0x00 0x00 0xFF 0x0D
* VMC -> MIB: 0x00 0x100
* VMC -> MIB: 0x00
== Protocol Packet Definition ==
=== Serial Port parameters ===
* Baud rate 115200
* 8bit, 1 stop bit, and no parity
=== Packet format ===
{| class="wikitable"
|-
| Start code || Length || mode || MDB Raw Data || Checksum || End code
|}

MDB Communication Protocal

2022-07-22T06:52:01Z

Xuyin: Created page with "== Introductio == This doc defines a serial protocol for Q3V application to communicate with MDB vending machine. Basically, the protocol is a f === Heading text ==="

== Introductio ==
This doc defines a serial protocol for Q3V application to communicate with MDB vending machine.
Basically, the protocol is a f
=== Heading text ===