doxygenAutoDocs
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
JsonSDK.JsonSDK Class Reference

Public Member Functions

 __init__ (self)
 
 MessengerGet (self, Any ptrComm, COMM_TYP commTyp, int maxInputMsgCapacity, bool usingDataPort)
 
 MessengerRelease (self)
 
 MessengerSendMsg (self, str strCommand, str strContent)
 
 MessengerReadNextMsg (self, strNextMsg)
 
 MessengerSendMsgAndWaitForResponse (self, strCommand, strContent, maxWaitTimeSecs, strResponse)
 
 MessengerUnreadMsgCount (self)
 
 RfidMonitorConnection (self, lpAddress)
 
 OdvMonitorConnection (self, lpAddress)
 
 PrinterMonitorConnection (self, lpAddress, InfoTyp)
 
 GetPrinterInfo (self, pPrtInfo, InfoTyp)
 
 GetRfidReportListening (self)
 
 SetRfidReportListening (self, value)
 
 GetOdvReportListening (self)
 
 SetOdvReportListening (self, value)
 
 RfidMonitorDispose (self)
 
 OdvMonitorDispose (self)
 
 PrinterMonitorDispose (self, InfoTyp)
 
 SetRfidReportCallback (self, callback)
 
 SetOdvReportCallback (self, callback)
 
 SetEngineStatusListening (self, value)
 
 SetDisplayStatusListening (self, value)
 
 SetAlertStatusListening (self, value)
 
 GetEngineStatusListening (self)
 
 GetDisplayStatusListening (self)
 
 GetAlertStatusListening (self)
 
 SetEngineStatusCallback (self, callback)
 
 SetDisplayStatusCallback (self, callback)
 
 SetAlertStatusCallback (self, callback)
 

Public Attributes

 AllMsg
 

Constructor & Destructor Documentation

◆ __init__()

JsonSDK.JsonSDK.__init__ ( self)

Member Function Documentation

◆ GetAlertStatusListening()

JsonSDK.JsonSDK.GetAlertStatusListening ( self)
Get the flag of alert status listening

Return: bool

◆ GetDisplayStatusListening()

JsonSDK.JsonSDK.GetDisplayStatusListening ( self)
Get the flag of display status listening

Return: bool

◆ GetEngineStatusListening()

JsonSDK.JsonSDK.GetEngineStatusListening ( self)
Get the flag of engine status listening

Return: bool

◆ GetOdvReportListening()

JsonSDK.JsonSDK.GetOdvReportListening ( self)
Get the flag of ODV report listening

Return: bool

◆ GetPrinterInfo()

JsonSDK.JsonSDK.GetPrinterInfo ( self,
pPrtInfo,
InfoTyp )
Get the information for RFID or ODV function

Param: 
pPrtInfo: A struct to store the printer information
InfoTyp: Set the type for RFID or ODV information

Return: None

Sample:

prt_info = PrinterInfo()
GetPrinterInfo(prt_info, INFO_TYP.RFID_TYP)

◆ GetRfidReportListening()

JsonSDK.JsonSDK.GetRfidReportListening ( self)
Get the flag of RFID report listening

Return: bool

◆ MessengerGet()

JsonSDK.JsonSDK.MessengerGet ( self,
Any ptrComm,
COMM_TYP commTyp,
int maxInputMsgCapacity,
bool usingDataPort )
Creates a channel for sending/receiving management messages with a maximum capacity specified.

Param: 
ptrComm: A pointer to storage communicating I/F
commTyp: Set the type of interface
maxInputMsgCapacity: The default value is MAX_INPUT_MSG_CAPACITY(20)
usingDataPort: The default value is False

Return: None

Sample:

comm_typ = COMM_TYP.TCP_COMM
commPtr = None
MessengerGet(commPtr, comm_typ, MAX_INPUT_MSG_CAPACITY, False)

◆ MessengerReadNextMsg()

JsonSDK.JsonSDK.MessengerReadNextMsg ( self,
strNextMsg )
Read next message that may have been received asynchronously from printer.

Param: 
strNextMsg: A buffer to store the next returned message

Return: None

◆ MessengerRelease()

JsonSDK.JsonSDK.MessengerRelease ( self)
Release the Messenger resource.

Return: None

Sample:

MessengerRelease()

◆ MessengerSendMsg()

JsonSDK.JsonSDK.MessengerSendMsg ( self,
str strCommand,
str strContent )
Send a management command and data/content to printer.

Param: 
strCommand: A management command string
strContent: A management data/content string

Return: None

Sample:

pCmdStr = "Cfg.Item"
content = "{\r\n"
content += "\"Speed\" : null,\r\n"
content += "\"ODV.Symbol\" : null,\r\n"
content += "\"Label.Sensor\":null\r\n"
content += "}\r\n"
pContentStr = content
MessengerSendMsg(pCmdStr, pContentStr)

◆ MessengerSendMsgAndWaitForResponse()

JsonSDK.JsonSDK.MessengerSendMsgAndWaitForResponse ( self,
strCommand,
strContent,
maxWaitTimeSecs,
strResponse )
Send a management command and data/content to printer and wait for response maxWaitTimeSecs time.

Param: 
strCommand: A management command string
strContent: A management data/content string
maxWaitTimeSecs: A maximum waiting time
strResponse: A buffer to store the JSON string response

Return: None

Sample:

MAX_WAIT_TIME_SECS = 5
pCmdStr = "Cfg.Item"
content = "{\r\n"
content += "\"Speed\" : null,\r\n"
content += "\"ODV.Symbol\" : null,\r\n"
content += "\"Label.Sensor\":null\r\n"
content += "}\r\n"
pContentStr = content
strResponse = None
MessengerSendMsgAndWaitForResponse(pCmdStr, pContentStr, MAX_WAIT_TIME_SECS, strResponse)

◆ MessengerUnreadMsgCount()

JsonSDK.JsonSDK.MessengerUnreadMsgCount ( self)
Get the count for the unread messages

Return: int

Sample:

iUnreadMsgCount = MessengerUnreadMsgCount()

◆ OdvMonitorConnection()

JsonSDK.JsonSDK.OdvMonitorConnection ( self,
lpAddress )
Use NET I/F to connect the printer for ODV monitor function

Param: 
ipAddress: IP address

Return: None

Sample:

ptr_ip_odv = "10.0.10.171"
OdvMonitorConnection(ptr_ip_odv)

◆ OdvMonitorDispose()

JsonSDK.JsonSDK.OdvMonitorDispose ( self)
Release ODV monitor resource

Return: None

◆ PrinterMonitorConnection()

JsonSDK.JsonSDK.PrinterMonitorConnection ( self,
lpAddress,
InfoTyp )
Use NET I/F to connect the printer for the status of printer monitor

Param: 
ipAddress: IP address
InfoTyp: Set the type for RFID or ODV information 

Return: None

Sample:

ptr_ip_rfid = "10.0.10.178"
rfid_monitor_connection(ptr_ip_rfid)
PrinterMonitorConnection(ptr_ip_rfid, INFO_TYP.RFID_TYP)

◆ PrinterMonitorDispose()

JsonSDK.JsonSDK.PrinterMonitorDispose ( self,
InfoTyp )
Release printer monitor resource

Param: 
InfoTyp: Set the type for RFID/ODV/printer status information

Return: None

◆ RfidMonitorConnection()

JsonSDK.JsonSDK.RfidMonitorConnection ( self,
lpAddress )
Use NET I/F to connect the printer for RFID monitor function

Param: 
ipAddress: IP address

Return: None

Sample:

ptr_ip_rfid = "10.0.10.178"
RfidMonitorConnection(ptr_ip_rfid)

◆ RfidMonitorDispose()

JsonSDK.JsonSDK.RfidMonitorDispose ( self)
Release RFID monitor resource

Return: None

◆ SetAlertStatusCallback()

JsonSDK.JsonSDK.SetAlertStatusCallback ( self,
callback )
Set a callback function to get alert status

Param: 
callback: a callback function

Return: None

Sample:

SetAlertStatusCallback(PtrAlertNoticeListener)

◆ SetAlertStatusListening()

JsonSDK.JsonSDK.SetAlertStatusListening ( self,
value )
Set the flag of printer report listening for alert status

Param: 
value: a flag to set printer report listening

Return: None

Sample:

SetAlertStatusListening(True)

◆ SetDisplayStatusCallback()

JsonSDK.JsonSDK.SetDisplayStatusCallback ( self,
callback )
Set a callback function to get display status

Param: 
callback: a callback function

Return: None

Sample:

SetDisplayStatusCallback(PtrDisplayStatusNoticeListener)

◆ SetDisplayStatusListening()

JsonSDK.JsonSDK.SetDisplayStatusListening ( self,
value )
Set the flag of printer report listening for display status

Param: 
value: a flag to set printer report listening

Return: None

Sample:

SetDisplayStatusListening(True)

◆ SetEngineStatusCallback()

JsonSDK.JsonSDK.SetEngineStatusCallback ( self,
callback )
Set a callback function to get engine status

Param: 
callback: a callback function

Return: None

Sample:

SetEngineStatusCallback(PtrEngineStatusNoticeListener)

◆ SetEngineStatusListening()

JsonSDK.JsonSDK.SetEngineStatusListening ( self,
value )
Set the flag of printer report listening for engine status

Param: 
value: a flag to set printer report listening

Return: None

Sample:

SetEngineStatusListening(True)

◆ SetOdvReportCallback()

JsonSDK.JsonSDK.SetOdvReportCallback ( self,
callback )
Set a callback function to get ODV report

Param: 
callback: a callback function

Return: None

Sample:

SetOdvReportCallback(OdvReportCallback)

◆ SetOdvReportListening()

JsonSDK.JsonSDK.SetOdvReportListening ( self,
value )
Set the flag of ODV report listening

Param: 
value: A flag to set ODV report listening

Return: None

Sample:

SetOdvReportListening(True)

◆ SetRfidReportCallback()

JsonSDK.JsonSDK.SetRfidReportCallback ( self,
callback )
Set a callback function to get RFID report

Param: 
callback: a callback function

Return: None

Sample:

SetRfidReportCallback(RfidReportCallback)

◆ SetRfidReportListening()

JsonSDK.JsonSDK.SetRfidReportListening ( self,
value )
Set the flag of RFID report listening

Param: 
value: A flag to set RFID report listening

Return: None

Sample:

SetRfidReportListening(True)

Member Data Documentation

◆ AllMsg

JsonSDK.JsonSDK.AllMsg

The documentation for this class was generated from the following file: