Gonector 1.1 Syntax

1. Basic technical parameters

File name:	Gonector.fmplugin
plugin ID String:	24GO
Function names prefix:	Gonector_
iOS version:	11.2.6 and newer
SN product code and versions:	GON11I
SNLib version:	SNlib-iOS 1.0
Supported Bluetooth 4.0 devices:	qIDMiniqIDmini with Apple profile (R1170IEAPLP) produced by CAENRFID Custom MyPrinter A Custom MY3 BlueSnap Smart (RS232 to Bluetooth adapter)
Supported RS232 via BlueSnap Smart adapter (Bluetooth 4.0) devices:	Scales with RS232 interface configured via Gonector_Set with selectors "scaleReadCommand" and "scaleWeightPattern" Tested on: Traveler TA301 OHAUS scale LESAK J1-RWP scale
Supported directly connected devices:	Linea and Infinea product line from Infinite Peripherals Tested on: LINEA PRO 7 encrypted
Supported iOS devices for native RFID/NFC tag reading:	iPhone 7 and higher with iOS 11 and newer
Supported NFC cards:	ISO 14443A (Mifare Classic 1k, Mifare Ultralight) ISO 15693 cards
Product icon:

2. Distribution archive (DA)

• DA will be created only for iOS as .zip file and will contain:
  • Plug-In binaries for iOS, iOSSimulator, macOS (dummy) and Windows (dummy)
  • Examples for CustomPrinter, qIDMiniqIDmini, Linea Pro 7, BlueSnap Smart and native iPhone RFID/NFC tag reading.
  • Documentation: Licence agreement, HowToRegister, ReadMe, ReleaseNotes, Syntax, UsingFMPlugins and manual for supported devices.
  • Link to 24usoftware.com site
  • Link to Xgode in the ReadMe file
  • WhatIsNew.html document

3. Supported OS for development and testing in desktop version of the plug-in:

Windows	Windows 7 and newer, FileMaker 16.0 and higher
macOS	macOS Sierra 10.12, FileMaker 16.0 and higher

Functions return either default testing values or "notImplemented". This has to be set with function Gonector_Set.
The plugin used for desktop integration does not require SNLib verification

Gonector_Register( selector )

Provides special functionality to operate with plugin serial numbers

Parameter values for selector

SerialNumber	Register given SerialNumber and return an error code
"Status"	Returns only one of two states: "Registered" or "Unregistered"
"Unregister"	Unregister all serial numbers related to the product and return an error code

Gonector_Connect( deviceName )

Connect to the device specified

Parameters

deviceName

To connect to native iPhone RFID/NFC Reader use "iPhone" as deviceName To connect to Linea or Infinea product line use "LineaInfinea" as deviceName deviceName for connectable bluetooth devices can be received through the function Gonector_Get( "devices" ; deviceType)

Description

This function will try to find device with provided deviceName and connect to it.
In case of CustomPrinter and qIDMiniqIDmini device has to be paired via bluetooth.

Result

Function returns 0 if connected. In case of error the function will return "?". Use Gonector_Get( "lastError" ) to get the specific error code.

Examples

Gonector_Connect( "MYPrinterA_1" )
This command connects the plugin to the bluetooth device MYPrinterA_1.

Gonector_Connect( "LineaInfinea" )
This command connects the plugin to the device of Linea or Infinea type.
If You have troubles connecting to the device please check the LineaInfinea troubleshooting guide

Gonector_Connect( "iPhone" )
This command connects the plugin to the iPhone.

Gonector_Disconnect( deviceName )

Disconnect from the device

Parameters

deviceName

Use the particular name to disconnect solely this device

Description

This function is used to disconnect from the device.

Result

Function returns 0. In case of error the function will return "?". Use Gonector_Get( "lastError" ) to get the specific error code.

Examples

Gonector_Disconnect( "MYPrinterA_1" )
This command disconnects the device MYPrinterA_1.

Examples

Gonector_Get( "inlineDocumentation" )
This command returns "on" or "off".

Gonector_Get( "devices" ; "customPrinter" )
This command returns all customPrinter devices divided by ";".

Gonector_Get( "fontAlignment" ; "MYPrinterA_1" )
This command returns "left" if the device MYPrinterA_1 has default alignment.

Gonector_Get( "randomKey" ; "LineaInfinea" )
This command returns string such as "16465168765168416845198645316551".

Gonector_Get( "barcodeHri" ; "MYPrinterA_1" )
This command returns "bottom" if the device MYPrinterA_1 has HRI set to default.

Gonector_PrintText( deviceName ; text { ; printMode } )

Sends a text to print

Parameters

deviceName	Unique name of the device
text	Text to print Note: Supported printers only print ASCII character set
printMode	This parameter is used to change different print modes

Possible values for printMode.

"buffer"

This printMode can be used to print various fonts in one line. The printer will store the text in a buffer. Text is added to the buffer and currently set formatting is remembered along with it. If the text in the buffer contains line ending (¶) or if the text fulfils width of the printable line, it is automatically printed and the remaining part of the text will stay in the buffer. Combining multiple text alignments on one row is not possible. Overwriting of the line alignment for text in buffer is not possible.

"immediate"

This printMode will automatically add line ending at the end of provided text which means that buffer (first) and the text (second) will be printed immediately. If buffer and text is empty printer will print empty line. This is default printMode.

Description

This function uses a printer to print text. Various font settings can be changed using Gonector_Set function

Result

Function returns 0 in case of success. In case of error the function will return "?". Use Gonector_Get( "lastError" ) to get the specific error code.

Examples

Gonector_PrintText( "MYPrinterA_1" ; "Hello!!!" )
This prints "Hello!!!" on the device MYPrinterA_1.

Gonector_PrintText( "MYPrinterA_1" ; "Name: " ; "on""buffer" ) & ¶ & Gonector_Set( "fontUnderline" ; "MYPrinterA_1" ; "on""buffer" ) & ¶ & Gonector_PrintText( "MYPrinterA_1" ; "name@example.com" )
This prints "Name: name@example.com" on the device MYPrinterA_1.

Gonector_PrintCode( deviceName ; type ; text )

Prints a barcode

Parameters

deviceName	Unique name of the device
type	The type of code
text	The text to be printed as a barcode. See specific barcode types below to see what type of character strings are supported. The text has to be valid for selected code type otherwise the code can be unreadable

Description

This function uses a printer to print a barcode. Various settings can be changed using Gonector_Set function.

Possible values for type

The printer nor plugin are checking the validity of barcodes.

Type of 1D code	Description and limitations
CODABAR	Supported characters are numbers (0-9), 4 letters (A,B,C,D) and few special characters (-$:/.+). The code must be valid including starting and ending letters. The 14 digits barcode is only supported on MY3 A printer
UPCA	11 or 12 digits. Supplemental code is not supported. Code must be valid. In case the checkdigit is not known it is better to use only 11 digits
UPCE	11 or 12 digits. The UPCA code must must be capable to be compressed into the UPCE code. Supplemental code is not supported. The printer prints a short version of UPCA code by trimming the padding zero's. Part of the UPCA codes are excluded if they overcome the padded amount in more categories. If checkdigit is not known then the printer will calculate the checkdigit automatically
EAN13	13 digits. Supplemental code is not supported. The code must be valid
EAN8	8 digits. The code must be valid
CODE39	Upper case letters, numbers, some symbols, (A-Z, 0-9, space, $ % + - . /)
ITF	Up to 14 digits. The code must be valid
CODE93	43 basic symbols (0–9, A-Z, "-", ".", "$", "/", "+" and "%")
CODE128	All ASCII characters. Preferred set is Code B. Code C is automatically switched on from 6 following digits to compress the barcode using high density mode. Any combination of characters is allowed
CODE32	8 or 9 digits. "A" will be prepended automatically. If checkdigit is not known it is better to provide 8 digits only. In case of 7 digits a leading 0 digit must be used

Type of 2D code	Description and limitations
DATAMATRIX	All ASCII characters. Supports UTF-8 data stream
PDF417	All ASCII characters. Recommended minimum barcode2dWidth is 300 (px)
MICROPDF417	All ASCII characters. The code must be valid
AZTEC	All ASCII characters. Supports UTF-8 data stream
QRCODE	All ASCII characters. Supports UTF-8 data stream. Kanji is not supported
MICROQRCODE	All ASCII characters. Supports UTF-8 data stream. Kanji is not supported

Result

Function returns 0 in case of success. In case of error the function will return "?". Use Gonector_Get( "lastError" ) to get the specific error code.

Examples

Gonector_PrintCode( "MYPrinterA_1" ; "04210000526" ; "UPCA" )
This prints UPCA barcode with HRI of "042100005264" on the device MYPrinterA_1.

Gonector_PrintCode( "MYPrinterA_1" ; "04210000526" ; "UPCE" )
This prints UPCE barcode with HRI of "425261" on the device MYPrinterA_1.

Gonector_PrintCode( "MYPrinterA_1" ; "Code 128" ; "CODE128" )
This prints CODE128 barcode with HRI of "Code 128" on the device MYPrinterA_1.

Gonector_PrintCode( "MYPrinterA_1" ; "123456789" ; "CODE128" )
This prints CODE128 barcode with HRI of "123456789" on the device MYPrinterA_1.

Gonector_PrintCode( "MYPrinterA_1" ; "Hello World" ; "QRCODE" )
This prints QR code with content of "Hello World" on the device MYPrinterA_1.

Gonector_Read( deviceName { ; selector { ; options } } )

Reads data from a device.

Parameters

deviceName	Unique name of the device
selector	Used to specify the request
options	Additional selector for some requests

Possible values for selector:

Selector	Supported device	Description
"single"	qIDMiniqIDmini Scale iPhone LineaInfinea (barcodes, RFID cards, magnetic stripes)	Read dialog will be shown for iPhone and Linea or Infinea device. This dialog closes after one item read. This is the default
"single"	qIDMiniqIDmini Scale iPhone LineaInfinea	Read dialog will be shown for iPhone and Linea or Infinea device. This dialog closes after one item read. This is the default Note: Read dialog for iPhone will close after 60 seconds of inactivity and return all read cards
"multiple"	qIDMiniqIDmini iPhone LineaInfinea (barcodes, RFID cards)	Read dialog will be shown for iPhone and Linea or Infinea device. This dialog closes when "Done" button is hit
"multiple"	qIDMiniqIDmini iPhone LineaInfinea	Read dialog will be shown for iPhone and Linea or Infinea device. This dialog closes when "Done" button is hit Note: Read dialog for iPhone will close after 60 seconds of inactivity and return all read cards
"unique"	qIDMiniqIDmini iPhone LineaInfinea (barcodes, RFID cards)	Read dialog will be shown for iPhone and Linea or Infinea device. This dialog closes when "Done" button is hit. The plugin guarantees that no value will be returned twice
"unique"	qIDMiniqIDmini iPhone LineaInfinea	Read dialog will be shown for iPhone and Linea or Infinea device. This dialog closes when "Done" button is hit. The plugin guarantees that no value will be returned twice Note: Read dialog for iPhone will close after 60 seconds of inactivity and return all read cards
"last"	qIDMiniqIDmini Scale iPhone LineaInfinea (barcodes, RFID cards, magnetic stripes)	Returns the last value received from the device Data from magnetic stripe is only kept for 10 seconds to match the PCI compliance

Some scales (such as tested LESAK J1-RWP) have to be manually configured to enable this function.

Possible values for options:

Options	Supported device	Description
"stripe"	LineaInfinea	Reads a magnetic stripe. To successfully read the magnetic stripe, a stripe key must be set
"rfidCard"	LineaInfinea	Reads an RFID card
"barcode"	LineaInfinea	Reads a barcode

Description

Plugin sends a request to one of the supported devices to respond with data.

Result

Function returns JSON string if everything is OK. In case of error the function will return "?". Use Gonector_Get( "lastError" ) to get the specific error code.
The JSON string contains an array of items read (cards, tags…). The items are wrapped in arrays which contain one or more objects. Each object represents one chunk of items data (e.g. in case of localised rfid cards one object would be for data in English and another object for data in German). Each object has at least “type” and “data” or “base64Data” properties.

Examples

Gonector_Read( "qIDMiniqIDmini R1170" ; "multiple" )
This returns a JSON string such as [ [ { "type": "qIDMiniqIDminiTag", "data": "123456" }, { "type": "qIDMiniqIDMiniTag", "data": "654321" } ] ] or "?" in case of an error.

Gonector_Read( "MIN-7943" )
This returns a JSON string such as [ [ { "type": "weight", "data": "0.05¶g" } ] ] or [ [ { "type": "rawData", "data": "ERROR 2" } ] ] or "?" in case of an error.

Gonector_Read( "LineaInfinea" ; "single" ; "stripe" )
This returns a JSON string such as [ [ { "type": "stripe", "data": "cardholderName¶cardholderFirstName¶cardholderLastName¶accountNumber¶serviceCode¶discretionaryData¶expirationMonth¶expirationYear" } ] ] or "?" in case of an error.

Gonector_Read( "LineaInfinea" ; "last" ; "rfidCard" )
This returns a JSON string such as [ [ { "language": "en", "type": "ndefText", "data": "Hello", "deviceName": "LineaInfinea" }, { "language": "cs", "type": "ndefText", "data": "Vítejte", "deviceName": "LineaInfinea" } ], [ { "type": "image/jpeg", "base64Data": "SGVsbG8=" } ] ] or "?" in case of an error.

Gonector_Read( "LineaInfinea" ; "unique" ; "barcode" )
This returns a JSON string such as [ [ { "deviceName": "deviceName", "type": "barcode", "barcodeType": "CODE128", "data": "Hello 1d code" }, { "deviceName": "deviceName", "type": "barcode", "barcodeType": "QRCODE", "data": "Hello 2d code" } ] ] or "?" in case of an error.

Gonector_Read( "iPhone" )
This returns a JSON string such as [ [ { "type": "text/plain", "data": "Hello" } ] ] or "?" in case of an error.

Gonector_Write( deviceName ; options ; value { ; cardLocking } )

Writes data to the device.

Parameters

deviceName	Unique name of the device
options	Specific options
value	The value to be written
cardLocking	Can be "lock" or empty string. In case of "lock" read/write card will be locked and cannot be rewritten in the future. Default value is "". This is a one way process. Locked card cannot be unlocked

Possible values for options:

Options	Supported device	Description
"rawData"	LineaInfinea	Writes raw data onto the card. Write dialog will be shown
"ndefText"	LineaInfinea	Writes an NDEF message formatted as a Well Known text to the NFC card. Write dialog will be shown
"ndefUri"	LineaInfinea	Writes an NDEF message formatted as a Well Known URI to the NFC card according to the RTD. Write dialog will be shown
"ndefMime"	LineaInfinea	Writes an NDEF message formatted as a MIME data to the NFC card. Images and other data based MIME types should be passed as container. Write dialog will be shown

Description

Plugin writes data through the selected device. In case of NDEF format, the card is formatted so that it is iPhone 7+ readable. The card will be completely rewritten.

Result

Function returns 0. In case of error the function will return "?". Use Gonector_Get( "lastError" ) to get the specific error code.

Examples

Gonector_Write( "LineaInfinea" ; "ndefUri" ; "https://www.24usoftware.com")
This writes an NDEF message as a URI to the present NFC card through the Linea or Infinea device.

Gonector_Write( "LineaInfinea" ; "ndefMime" ; test::container )
This writes an NDEF message as a MIME to the present NFC card through the Linea or Infinea device.

Gonector_Write( "LineaInfinea" ; "ndefText" ; "Hello World" ; "on""lock")
This writes an NDEF message as a Text to the present NFC card through the Linea or Infinea device and lock it.

Gonector_RawCommand( deviceName ; value )

Sends raw data to the BlueSnap Smart device

Parameters

deviceName	Unique name of the device
value	String of the data to be sent

Description

This function is used to send raw data to the scale. See the scale's manual to see what kind of messages the scale supports.

Result

Function returns 0. In case of error the function will return "?". Use Gonector_Get( "lastError" ) to get the specific error code.

Examples

Gonector_RawCommand( "MIN-7943" ; "R" )
This command sends RawCommand "R" to the BlueSnap Smart device

5. Registered Custom Script Steps

• Gonector Register
• Gonector Connect
• Gonector Disconnect
• Gonector Set
• Gonector PrintText
• Gonector PrintImage
• Gonector PrintCode
• Gonector SetScriptEvent
• Gonector Read
• Gonector Write
• Gonector RawCommand