> For the complete documentation index, see [llms.txt](https://developer.magtek.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developer.magtek.com/sdks-and-tools/universal-sdk-documentation/ios/coreapi.md). # CoreAPI ## CoreAPI Use the CoreAPI to create an IDevice. IDevice, which is the bases for the MagTek Universal SDK. If accessing a device specific API outside of MagTek Universal SDK, use the various functions in this section to create an instance of that device’s API. Once a device specific API is referenced, the associated library will need to be added into the application’s development project. ## createCMSDevice This function creates an instance of a CMS type of device. The API’s of MagTek Universal SDK do not apply. See *D998200160 MagTek Common Message Structure (MTCMS)* for the MTCMS API. ```java MTDevice CoreAPI.createCMSDevice(Context context, Handler handler); ``` Return Value: Returns an MTDevice ## createDevice This function creates an instance of IDevice. All API’s of MagTek Universal SDK can but utilized from. {% code overflow="wrap" %} ```java IDevice CoreAPI.createDevice( DeviceType deviceType, ConnectionType connectionType, string address, string model, string name, string serial, CertificateInfo certificateInfo = null); ``` {% endcode %} **Parameter**
ParameterDescription
deviceTypeEnumerated device type.
connectionTypeEnumerated connection type.

address

Address for the device.

For USB devices, address may be an empty string when only one device is attached. Otherwise, address should be in the form:

USB://DEVICESERIALNUMBER

for example, USB://99261829170E0810

For Ethernet devices, address should be in the form:

IP://IP-Address:PORT

for example, IP://10.57.10.180:26

For Wireless DynaPro Go devices, address should be in the form: TLS12://TLSDEVICESERIALNUMBER TLS12TRUST://TLSDEVICESERIALNUMBER

for example, TLS12://TLS99261829170E0810 TLS12TRUST://TLS99261829170E0810

For Bluetooth LE devices, address should be in the form:

BLEEMV://DEVICENAME

for example, BLEEMV://DynaPro Go-EB66

For WebSocket or Secure WebSocket devices, address should be in the form:

ws://IP-Address or DEVICEADDRESS wss://IP-Address or DEVICEADDRESS

for example, ws://10.57.10.1 or ws://b512345.magtek.com wss://192.168.1.150 or wss://b512345.magtek.com

The client private key certificate (client.p12) must be accessible to the custom software that makes a secure WebSocket (wss://) connection to the DynaFlex II PED.

For Serial devices, address should be in the form: PORT=[PORT],

BAUDRATE=[BAUDRATE], DATABITS=[DATABITS], PARITY=[PARITY], STOPBITS=[STOPBITS], HANDSHAKE=[HANDSHAKE], STARTINGBYTE=[STARTINGBYTE], ENDINGBYTE=[ENDINGBYTE], CRCMODE=[CRCMODE]

modelModel name for the device.
nameUnique name for the device to distinguish between multiple devices of the same model.
serialSerial number for the device.
certificateInfo

Certificate information for TLS Trust and WebSocket WSS connection. Optional. See the following for details on installing a certificate chain: D998200550 DynaFlex II PED Using Wireless LAN Guide.

The client private key certificate (client.p12) must be accessible to the custom software that makes a secure WebSocket (wss://) connection to the DynaFlex II PED.

The client.p12 certificate is not needed if the connection type is not secure WebSocket (ws://)

**Return Value:** Returns an IDevice. #### createMMSDevice This function creates an instance of an MMS type of device, DynaFlex Family. ```java MMXDevice CoreAPI.createMMSDevice(); ``` Return Value: Returns an MMXDevice. ## createPPSCRA This function creates an instance of an MTPPSCRA type of device. The API’s of MagTek Universal SDK do not apply. See *D998200078 IPAD, DynaPro, DynaPro Go, and DynaPro Mini PIN Encryption Devices Programmer’s Reference* for the MTPPSCRA API. ```java MTPPSCRA CoreAPI.createPPSCRA(); ``` Return Value: Returns an MTPPSCRA. ## createSCRA This function creates an instance of a MTSCRA type of device. The API’s of MagTek Universal SDK do not apply. See *uDynamo, Dynamag, DynaMAX, eDynamo, mDynamo, Insert, DynaWave, iDynamo 6* for the MTSCRA API. ```java MTSCRA CoreAPI.createPPSCRA(Context context, Handler handler); ``` **Return Value:** Returns an MTSCRA. ## getDeviceList This function returns a list of IDevice. IDevice is the base for utilizing the MagTek Universal SDK interface. ```java List CoreAPI.getDeviceList(); List CoreAPI.getDeviceList(DeviceType deviceType); List CoreAPI.getDeviceList(List deviceTypes); ```
ParameterDescription
deviceTypeAn enum for the type of MagTek readers which the SDK will control.
deviceTypesAn enum list for the type of MagTek readers which the SDK will control.
Return Value: Returns a list of IDevice. ## getAPIVersion This function returns the API version. ```java int CoreAPI.getAPIVersion(); ``` **Return Value:** Returns an integer representing the API version. ## setMQTTBrokerInfo This function sets the MQTT (Message Queuing Telemetry Transport) broker information. Call prior to device discovery. ```java void setMQTTBrokerInfo( string uri, string username = null, string password = null); ```
ParameterDescription

uri

URI included the port. Support URIs:

  • TCP: “test.mosquitto.org”, “test.mosquitto.org:1883”, “mqtt://test.mosquitto.org:1883”, “mqtt://broker.emqx.io:1883”
  • TCP (Authenticated): “test.mosquitto.org:1884”, “mqtt://test.mosquitto.org:1884”
  • TCP (Encrypted): “mqtts://test.mosquitto.org:8886”, “mqtts://broker.emqx.io:8883”
  • TCP (Encrypted & Authenticated): “mqtts://test.mosquitto.org:8885”
  • WebSocket: “ws://test.mosquitto.org:8080”, “ws://broker.emqx.io:8083”
  • WebSocket (Encrypted): “wss://test.mosquitto.org:8081” , “wss://broker.emqx.io:8084”
  • WebSocket (Authenticated): “ws://test.mosquitto.org:8090”
  • WebSocket, (Encrypted & Authenticated): “wss://test.mosquitto.org:8091”
usernameUsername
passwordPassword
Return Value: None ## setMQTTClientID This function sets the MQTT client ID to establish a connection. ```java void setMQTTClientID(string clientID); ```
ParameterDescription
clientIDClient ID. If not set, the default value is [HostName]-[RandomUUID]
**Return Value:** None ## setMQTTClientCertificateInfo This function sets the MQTT certificate information. ```java void setMQTTClientCertificateInfo(CertificateInfo certificateInfo); ``` **Parameter**
ParameterDescription

certificateInfo

If client certificate is required when initiating a connection to the MQTT broker, this shall be used to establish the connection. If not set, the default value is NULL.
**Return Value:** None ## setMQTTDeviceDiscoveryTimeout This function sets the MQTTDeviceDiscoveryTimeout value. ```java void setMQTTDeviceDiscoveryTimeout(int timeout); ```
ParameterDescription
timeoutTime out in milliseconds. Default value = 5000 if not set. A call to getDeviceList() does not return the list until this time has expired.
**Return Value:** None ## startMQTTDeviceStatusMonitoring This function sets the MQTT callback interface instance. After connecting to the MQTT broker, the MQTT Device Status Monitoring subscribes to “\/#”. The wildcard “/#” is automatically appended. Example: {% code overflow="wrap" %} ``` subscribe topic = “MagTek/Server/DynaFlexIIPED” monitored subscription = “MagTek/Server/DynaFlexIIPED/#”. ``` {% endcode %} When a device status updates to “connected” or “disconnected”, OnConnected() and OnDisconnected() are invoked respectively. This method can be called whether or not there is an active connection to an MQTT device. {% code overflow="wrap" %} ``` void startMQTTDeviceStatusMonitoring( IMQTTDeviceStatusCallback callback); ``` {% endcode %} Return Value: None ## setMQTTPublishTopic This function sets the base value for MQTTPublishTopic.. When connected to the MQTT broker, the composed topic is in the format: ``` “//MMSMessage”. ``` Example: * Base topic = “MagTek/Device/DynaFlexIIPED/” * Full topic = “MagTek/Device/DynaFlexIIPED/B51E72D/MMSMessage” ```java void setMQTTPublishTopic(string topic); ```
ParameterDescription
topicBase topic for which to publish messages. Full topic is composed by the SDK.
**Return Value:** None ## setMQTTQos This function sets the MQTTQoS value. ```java void setMQTTQos(int qos); ``` **Parameter**
ParameterDescription

qos

The quality of service level for publishing messages. Range:

0 = At most once (default)

1 = At least once

2 = Exactly once

**Return Value:** None ## setMQTTSubscribeTopic This function sets the base value for MQTTSubscribeTopic. When connected to the device, the composed topic is in the format: “\/\//MMSMessage”. Example: * Base topic = “MagTek/Server/DynaFlexIIPED/” * Full topic = “MagTek/Server/DynaFlexIIPED/B51E72D/MMSMessage” ```java void setMQTTSubscribeTopic(string topic); ``` **Parameter**
ParameterDescription
topicBase topic for which to subscribe for messages. Full topic is composed by the SDK.
**Return Value:** None ## stopMQTTDeviceStatusMonitoring This function stops the MQTT device status monitoring process. If called when already running, the process shall be stopped immediately. This method can be called whether or not there is an active connection to an MQTT device. ```java void stopMQTTDeviceStatusMonitoring(); ``` **Return Value:** None ## setSystemStatusCallback This function sets the SystemStatusCallback global value. ```java void setSystemStatusCallback(ISystemStatusCallback callback); ``` **Parameter**
ParameterDescription

callback

Name of a class or structure that implements the ISystemStatusCallback interface event. Call before starting any MQTT communication. When there is an error, the interface’s OnError() event is invoked.
**Return Value:** None --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://developer.magtek.com/sdks-and-tools/universal-sdk-documentation/ios/coreapi.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.