SavoySecsI ActiveX Control User Guide

Size: px

Start display at page:

Download "SavoySecsI ActiveX Control User Guide"

Chrystal Clark
5 years ago
Views:

1 ActiveX Control User Guide Jazz Soft, Inc.

2 Revision History 1 Revision History Version Date Name Description 1.00 Jul, 31 st, 2009 Hikaru Okada Created as new document 1.00a Aug, 22 nd, 2009 Hikaru Okada Splitted into separate document, since number of pages became large. 1.00b Aug, 30 th, 2009 Hikaru Okada Mended some incorrect description. 1.00c Jul, 22 nd, 2010 Hikaru Okada Mended some incorrect description

3 Table of Contents 2 Table of Contents 1 Revision History Table of Contents SavoySecsI Properties Appearance BaudRate BorderStyle Connect DeviceID IniFileName IniSection Log LogBakCount LogFileName LogSize LogVerbose Master MSEC PortNumber Retry T T T T Methods AboutBox LoadIniFile Send Setup Events Problem Received Sent

4 3 SavoySecsI SavoySecsI control is an assistant product to develop SEMI E4 (SECS-I) compliant communication application software. SavoySecsI control can be used for either equipment side development or host side development. Usually SavoySecsI control will be used with SavoySecsII control. Properties Name Appearance BaudRate BorderStyle Connect DeviceID IniFileName IniSection Log LogBakCount LogFileName LogSize LogVerbose Master MSEC PortNumber Retry T1 T2 T3 T4 Description Gets or sets the value that determines the appearance of a SavoySecsI control. Gets or sets the transfer speed through serial cable. Gets or sets whether the SavoySecsI control has a border. Gets or sets the serial connection status. Gets or sets the device ID. Gets or sets INI file name to read/write settings. Gets or sets section name in INI file to read/write settings. Gets or sets whether logging is enabled. Gets or sets the number of back-up file for logging. Get or sets the log file name. Gets or sets the log file size in kilobyte. Get or sets whether logging for detailed part is enabled. Gets or sets whether SavoySecsI control acts as master or slave. Gets or sets whether Mitsubishi SECS protocol is enabled. Gets or sets the serial port number. Gets or sets the number of attempt in case of send error. Gets or sets the T1 time out in milliseconds. Gets or sets the T2 time out in milliseconds. Gets or sets the T3 time out in milliseconds. Gets or sets the T4 time out in milliseconds. Methods Name AboutBox LoadIniFile Send Setup Description Opens version information dialog box on the screen. Loads settings from INI file and initialize properties. Send specified SECS-II message. Opens setup dialog box on the screen. Events Name Problem Received Sent Description Notifies that error has occurred. Notifies that SavoySecsI control received SECS-II message. Notifies that SECS-II message has been sent

5 3.1 Properties Appearance Gets or sets the value that determines the appearance of a SavoySecsI control. Value Description 0 Flat 1 Etched Appearance As Integer short GetAppearance() void SetAppearance(short).Appearance = 0.Appearance = 1 ' flat ' sunken m_ctrl.setappearance(0); m_ctrl.setappearance(1); // flat // sunken - 5 -

6 3.1.2 BaudRate Gets or sets the transfer speed through serial cable. Value Description bits per second bits per second bits per second bits per second bits per second bits per second bits per second bits per second bits per second Default value is BaudRate As Long long GetBaudRate() void SetBaudRate(long).PortNumber = 0.BaudRate = 9600.Retry = 3.Connect = True m_ctrl.setportnumber(0); m_ctrl.setbaudrate(9600); m_ctrl.setretry(3); m_ctrl.setconnect(true); - 6 -

7 3.1.3 BorderStyle Gets or sets whether the SavoySecsI control has a border. Value Description 0 No border 1 Fixed single border BorderStyle As Integer short GetBorderStyle() void SetBorderStyle(short).BorderStyle = 0.BorderStyle = 1 ' no border ' with border m_ctrl.setborderstyle(0); m_ctrl.setborderstyle(1); // no border // with border - 7 -

8 3.1.4 Connect Gets or sets the serial connection status. If Connect property is set to true, SavoySecsI control will attempt to open specified serial port. If serial port has not been opened, Connect property will be set to false. Connect As Boolean BOOL GetConnect() void SetConnect(BOOL).PortNumber = 0.BaudRate = 9600.Retry = 3.Connect = True m_ctrl.setportnumber(0); m_ctrl.setbaudrate(9600); m_ctrl.setretry(3); m_ctrl.setconnect(true); - 8 -

9 3.1.5 DeviceID Gets or sets the device ID. Device ID is 15 bits starting at second bit of SECS-II header. For SECS-I following header structure is used. Byte Description 1 R Device ID 2 3 W Stream 4 Function 5 E Block number 6 7 Source ID 8 9 Transaction ID 10 DeviceID As Long long GetDeviceID() void SetDeviceID(long).DeviceID = 1 m_ctrl.setdeviceid(1); - 9 -

10 3.1.6 IniFileName Gets or sets INI file name to read/write settings. If INI file name is either full path name or containing relative reference of folder name, INI file will be created and read in such location. Otherwise, INI file will be created in Windows OS system folder. For this reason, it is highly recommended using with folder name. If current directory is the location, add./ at the beginning. Either / (slash) or (back slash) can be used for separator of folder name. IniFileName As String CString GetIniFileName() void SetIniFileName(LPCTSTR).IniFileName =./Savoy.ini m_ctrl.setinifilename(./savoy.ini );

11 3.1.7 IniSection Gets or sets section name in INI file to read/write settings. If multiple SavoySecsI control were embedded in one project, it is possible to share same INI file by changing section name. Default setting is SavoyComm. IniSection As String CString GetIniSection() void SetIniSection(LPCTSTR).IniSection = "Host" [Host] section m_ctrl.inisection("host"); // [Host] section

12 3.1.8 Log Gets or sets whether logging is enabled. If this property is enabled, processing information will be written in log file. If this property is disabled, nothing will be written in log file. Value True False Description Write to log file Do not write log file Log As Boolean BOOL GetLog() void SetLog(BOOL).Log = True m_ctrl.setlog(true);

13 3.1.9 LogBakCount Gets or sets the number of back-up file for logging. If actual file size of log file exceeded LogSize property, SavoySecsI control will rename the file name and make a new empty log file. If number of back-up file reached to the value of LogBakCount property, SavoySecsI control will delete oldest back-up file. LogBakCount As Integer short GetLogBakCount() void SetLogBakCount(short).LogBakCount = 10 m_ctrl.setlogbakcount(10);

14 LogFileName Get or sets the log file name. Log file will be created in current directory. LogFileName As String CString GetLogFileName() void SetLogFileName(LPCTSTR).LogFileName = Savoy m_ctrl.setlogfilename( Savoy );

15 LogSize Gets or sets the log file size in kilobyte. If actual file size of log file exceeded LogSize property, SavoySecsI control will rename the file name and make a new empty log file. If number of back-up file reached to the value of LogBakCount property, SavoySecsI control will delete oldest back-up file. LogSize As Long long GetLogSize() void SetLogSize(long).LogSize = 1024 m_ctrl.setlogsize(1024);

16 LogVerbose Get or sets whether logging for detailed part is enabled. LogVerbose As Boolean BOOL GetLogVerbose() void SetLogVerbose(BOOL).LogVerbose = False m_ctrl.setlogverbose(false);

17 Master Gets or sets whether SavoySecsI control acts as master or slave. SEMI E4 defines that equipment side should be master and host side should be slave. Value False True Description Slave Master Master As Boolean BOOL GetMaster() void SetMaster(BOOL).Master = True Equipment.Master = False Host m_ctrl.setmaster(true); Equipment m_ctrl.setmaster(false); Host

18 MSEC Gets or sets whether Mitsubishi SECS protocol is enabled. Value False True Description SECS-I MSEC MSEC As Boolean BOOL GetMsec() void SetMsec(BOOL).MSEC = True m_ctrl.setmsec(true);

19 PortNumber Gets or sets the serial port number. Port number starts at 0. For example, comm #1 is 0, comm. #2 is 1. Default value is 0. PortNumber As Integer short GetPortNumber() void SetPortNumber(short).PortNumber = 0.BaudRate = 9600.Retry = 3.Connect = True m_ctrl.setportnumber(0); m_ctrl.setbaudrate(9600); m_ctrl.setretry(3); m_ctrl.setconnect(true);

20 Retry Gets or sets the number of attempt in case of send error. Retry As Integer short GetRetry() void SetRetry(short).PortNumber = 0.BaudRate = 9600.Retry = 3.Connect = True m_ctrl.setportnumber(0); m_ctrl.setbaudrate(9600); m_ctrl.setretry(3); m_ctrl.setconnect(true);

21 T1 Gets or sets the T1 time out in milliseconds. Default value is 0.5 seconds. T1 As Long long GetT1() void SetT1(long) Dim lt1 As Long lt1 =.T1 long lt1 = m_ctrl.gett1();

22 T2 Gets or sets the T2 time out in milliseconds. Default value is 10 seconds. T2 As Long long GetT2() void SetT2(long) Dim lt2 As Long lt2 =.T2 long lt2 = m_ctrl.gett2();

23 T3 Gets or sets the T3 time out in milliseconds. Default value is 45 seconds. T3 As Long long GetT3() void SetT3(long) Dim lt3 As Long lt3 =.T3 long lt3 = m_ctrl.gett3();

24 T4 Gets or sets the T4 time out in milliseconds. Default value is 45 seconds. T4 As Long long GetT4() void SetT4(long) Dim lt4 As Long lt4 =.T4 long lt4 = m_ctrl.gett4();

25 3.2 Methods AboutBox Opens version information dialog box on the screen. Sub AboutBox() void AboutBox() Return Value None..AboutBox m_ctrl.aboutbox();

26 3.2.2 LoadIniFile Loads settings from INI file and initialize properties. If loading was failed, values in persistent resource will be set. LoadIniFile method probably is called at the beginning of application, since it retrieves saved parameters by Setup method. Function LoadIniFile() As Boolean BOOL LoadIniFile() Return Value Return true if loading was successful. Otherwise return false. If false was returned, IniFileName property or IniSection property might be incorrect. Private Sub Form_Load() SwingHsms1.LoadIni End Sub void CxxxView::OnInitialUpdate() {... m_ctrl.loadini();.... }

27 3.2.3 Send Send specified SECS-II message. Function Send(lpszMessage As String) As Boolean BOOL Send(LPCTSTR lpszmessage) Argument lpszmessage Description Message to be sent Return Value Return true if message was successfully queued. Otherwise return false. SavoyHsms1.Send SavoySecsII1.Msg m_ctrl.send(m_msg.getmsg()); SavoySecsI control attempts to send message. Actual result of transmission will be reported by Sent event. If transmission was failed, Problem event with error code 8 (retry over) will occur after the all attempts were failed

SECS Tab Item Comm port # Baud rate Retry Master Device ID MSEC T1 T2 T3 T4 Description Serial port

28 3.2.4 Setup Opens setup dialog box on the screen. If user modified parameter and press OK button, data will be written in INI file. SECS Tab Item Comm port # Baud rate Retry Master Device ID MSEC T1 T2 T3 T4 Description Serial port number Communication speed Number of retry count Master (equipment) or slave (host) Device ID Mitsubishi special SECS T1 timer T2 timer T3 timer T4 timer Log Tab

29 Item Enable logging Enable communication log File name Number of backup files Maximum size of each file Description True if logging is enabled. True if communication logging is enabled. Log file name. Number of backup files. Size of log file. Function Setup(lpszCaption As String) As Boolean BOOL Setup(LPCTSTR lpszcaption) Argument lpszcaption Description Caption title of dialog box. If this value is NULL or (empty) string, the string of IniSection property will be used for caption tile. Return Value If user pressed OK button and parameters were saved in INI file successfully, Setup method returns true. If user pressed Cancel button or parameter saving was failed, Setup method returns false..setup "SECS-I Configuration" m_ctrl.setup("secs-i Configuration");

30 3.3 Events Problem Notifies that error has occurred. Event Problem(sErrorCode As Integer, lpszadditionalinfo As String) void OnProblem(short serrorcode, LPCTSTR lpszadditionalinfo) Argument serrorcode lpszadditionalinfo Description Error code (see below) Additional information Failed message when error code is 8 (retry over). Text1.Text = Error - Code : + Format$(sErrorCode) TRACE( Error - Code : %d,serrorcode); Error code Enumeration Description 1 ErrorSecsUnexpectedChar Received unexpected character. 2 ErrorSecsBadLength Length byte is not correct. 3 ErrorSecsBadSum Check sum error. 4 ErrorSecsBadParity Parity error. 5 ErrorSecsBadMultiBlockNumber Block number in multi-block message is not correct. 6 ErrorSecsBadBlockNumber Block number is neither 0 nor 1. 7 ErrorSecsNak Received NAK. 8 ErrorSecsRetry Retry over. 9 ErrorSecsT4 T4 time out. 10 ErrorSecsT2 T2 time out. 11 ErrorSecsT1 T1 time out. 12 ErrorSecsT3 T3 time out. 13 ErrorSecsBadDeviceID Device ID mismatched

31 3.3.2 Received Notifies that SavoySecsI control received SECS-II message. Event Received(lpszMsg As String) void OnReceived(LPCTSTR lpszmsg) Argument Description lpszmsg Received message With SavoySecsII1.Msg = lpszmsg If.Stream = 1 AND.Function = 13 Then S1F13... End If End With m_msg.setmsg(lpszmsg); if(m_msg.getstream()==1 && m_msg.getfunction()==13) { // S1F13... }

32 3.3.3 Sent Notifies that SECS-II message has been sent. Event Sent(lpszMsg As String) void OnSent(LPCTSTR lpszmsg) Argument Description lpszmsg Sent message SavoySecsII1.Msg = lpszmsg m_msg.setmsg(lpszmsg);

SavoyLog ActiveX Control User Guide

SavoyLog ActiveX Control User Guide ActiveX Control User Guide Jazz Soft, Inc. Revision History 1 Revision History Version Date Name Description 1.00 Nov, 13 th, 2009 Hikaru Okada Created as new document - 2 - Table of Contents 2 Table of