Campbell-scientific LoggerNet Server SDK Manuel d'utilisateur Page 1

LoggerNet ServerSoftware Development KitVersion 4.1Programmer’s ReferenceRevision: 12/11Copyright © 2004-2011Campbell Scientific, Inc.All rights rese

LoggerNet Software Development Kit Table of Contents 12. CsiLogMonitor Control... 12-1 12.1 Purpose of the CsiL

Section 17. CsiDatalogger Control Reference Datalogger.loggerName Name Datalogger.loggerName As String Valid Values Specifies the datalogger or stati

Section 17. CsiDatalogger Control Reference COM Return Values Table of Possible Values Code Meaning S_OK Success: Normal return Datalogger.programS

Section 17. CsiDatalogger Control Reference COM Return Values Table of Possible Values Code Meaning S_OK Success: Normal return Datalogger.serverLo

Section 17. CsiDatalogger Control Reference Table of Possible Values Code Meaning S_OK Success: Normal return E_CSI_BUSY Error: The property cannot

Section 17. CsiDatalogger Control Reference COM Return Values Table of Possible Values Code Meaning S_OK Success: Normal return E_CSI_INVALIDARG Er

Section 17. CsiDatalogger Control Reference COM Return Values Table of Possible Values Code Meaning S_OK Success: Normal return E_CSI_BUSY Error: C

Section 17. CsiDatalogger Control Reference COM Return Values Table of Possible Values Code Meaning S_OK Success: Normal return Datalogger.loggerCo

Section 17. CsiDatalogger Control Reference Datalogger.manualPollCancel() Name Datalogger.manualPollCancel() Description This method should be calle

Section 17. CsiDatalogger Control Reference Datalogger.programReceiveCancel() Name Datalogger.programReceiveCancel() Description This method attempts

Section 17. CsiDatalogger Control Reference Datalogger.programSendCancel() Name Datalogger.programSendCancel() Description This method attempts to c

LoggerNet Software Development Kit Table of Contents 17. CsiDatalogger Control Reference ...17-1 17.1 Datalogger Interface ...

Section 17. CsiDatalogger Control Reference COM Return Values Table of Possible Values Code Meaning S_OK Success: Normal return E_CSI_BUSY Error: A

Section 17. CsiDatalogger Control Reference Datalogger.serverConnect() Name Datalogger.serverConnect() Description This method attempts to connect t

Section 17. CsiDatalogger Control Reference Parameters successful: Describes whether a clock set or clock check succeeded. response_code: The follow

Section 17. CsiDatalogger Control Reference Enumeration Name Value Description co_outcome_invalid_device_name 9 Indicates that the device named b

Section 17. CsiDatalogger Control Reference Enumeration Name Value Description lf_failure_invalid_logon 3 Indicates that this control was unable

Section 17. CsiDatalogger Control Reference Datalogger_onManualPollComplete() Name onManualPollComplete(Boolean successful, manual_poll_outcome_type

Section 17. CsiDatalogger Control Reference Enumeration Name Value Description mp_outcome_communication_disabled 9 Indicates that LoggerNet has b

Section 17. CsiDatalogger Control Reference Datalogger_onProgramReceiveComplete() Name onProgramReceiveComplete(Boolean successful, prog_receive_outc

Section 17. CsiDatalogger Control Reference Enumeration Name Value Description pr_failure_cannot_open_file 9 Indicates that the file could not be

Section 17. CsiDatalogger Control Reference Parameters successful: Describes if the programSendStart was successful. response_code: Found in the tabl

LoggerNet Software Development Kit Table of Contents vi A.2.10 Collection Enabled ...

Section 17. CsiDatalogger Control Reference Enumeration Name Value Description ps_outcome_cannot_open_file 12 Indicates that the program to send

Section 17. CsiDatalogger Control Reference Datalogger_onProgramSent() Name onProgramSent() Description This event returns notification when the prog

Section 17. CsiDatalogger Control Reference Enumeration Name Value Description smp_outcome_server_security_blocked 6 Indicates that the account sp

Section 17. CsiDatalogger Control Reference Enumeration Name Value Description server_failure_session 2 Indicates that the communication session

Section 17. CsiDatalogger Control Reference 17-26

Section 18. CsiDataSource Control Reference 18.1 DSource Interface 18.1.1 Properties DSource.logonName Name DSource.logonName As String Descriptio

Section 18. CsiDataSource Control Reference COM Return Values Table of Possible Values Code Meaning S_OK Success: Normal return. E_CSI_BUSY Error:

Section 18. CsiDataSource Control Reference COM Return Values Table of Possible Values Code Meaning S_OK Success: Normal return. E_CSI_BUSY Error:

Section 18. CsiDataSource Control Reference Default Value This property is set to FALSE by default. COM Return Values Table of Possible Values Code M

Section 18. CsiDataSource Control Reference COM Return Values Table of Possible Values Code Meaning S_OK Success: Normal return E_CSI_NOT_CONNECTED

Section 1. LoggerNet Server SDK Overview 1.1 Purpose of the LoggerNet Server SDK The LoggerNet Server Software Development Kit (SDK) provides a meth

Section 18. CsiDataSource Control Reference COM Return Values Table of Possible Values Code Meaning S_OK Success: Normal return DSource_onAdviseRec

Section 18. CsiDataSource Control Reference Enumeration Name Value Description csiAdvisorFailureInvalidLogon 2 Indicates that this control was unab

Section 18. CsiDataSource Control Reference COM Return Values Table of Possible Values Code Meaning S_OK Success: Normal return DSource_onControlFa

Section 18. CsiDataSource Control Reference DSource_onControlReady() Name onControlReady() Description This event is triggered when a connection to

Section 18. CsiDataSource Control Reference Enumeration Name Value Description vo_outcome_column_read_only 5 Indicates that the column sent is read

Section 18. CsiDataSource Control Reference Description This event notification returns a block of records delivered by LoggerNet to an active adviso

Section 18. CsiDataSource Control Reference Enumeration Name Value Description csidsOrderLoggedWithHoles 2 The records will be sent in the order t

Section 18. CsiDataSource Control Reference Notes This property can be read at any time but can only be set when the state of the property is advisor

Section 18. CsiDataSource Control Reference Advisor.startIntervalSeconds Name Advisor.startIntervalSeconds As Long Description This property specifie

Section 18. CsiDataSource Control Reference Table of possible csidsStartOptionType values Enumeration Name Value Description csidsStartAtRecordId

Section 1. LoggerNet Server SDK Overview The C#.NET and VB.NET example code targets the x86 compilation platform to facilitate proper functionality o

Section 18. CsiDataSource Control Reference Advisor.startRecordNo Name Advisor.startRecordNo As Long Description This property, in conjunction with

Section 18. CsiDataSource Control Reference COM Return Values Table of Possible Values Code Meaning S_OK Success: Normal return E_CSI_BUSY Error: T

Section 18. CsiDataSource Control Reference COM Return Values Table of Possible Values Code Meaning S_OK Success: Normal return E_CSI_BUSY Error: T

Section 18. CsiDataSource Control Reference Advisor.maxRecordsPerBlock Name Advisor.maxRecordsPerBlock As Long Description This property sets the max

Section 18. CsiDataSource Control Reference COM Return Values Table of Possible Values Code Meaning S_OK Success: Normal return E_CSI_ALREADY_CONNEC

Section 18. CsiDataSource Control Reference Advisor.variableSetStart() Name Advisor.variableSetStart(String column_name, String value) As Long Descr

Section 18. CsiDataSource Control Reference 18.3 DataColumnCollection Interface 18.3.1 Properties DataColumnCollection.count Name DataColumnCollect

Section 18. CsiDataSource Control Reference DataColumnCollection.addAll() Name DataColumnCollection.addAll() Description This method adds all of the

Section 18. CsiDataSource Control Reference COM Return Values Table of Possible Values Code Meaning S_OK Success: Normal return E_CSI_INVALIDARG Er

Section 18. CsiDataSource Control Reference COM Return Values Table of Possible Values Code Meaning S_OK Success: Normal return DataColumnCollecti

Section 1. LoggerNet Server SDK Overview the controls. The standard installation program will register the SDK control DLLs. 1.3.2.1 Adding a Contr

Section 18. CsiDataSource Control Reference unique key for each record. This property can take on any value from 0 to 2147483647. COM Return Values

Section 18. CsiDataSource Control Reference COM Return Values Table of Possible Values Code Meaning S_OK Success: Normal return Record.valuesCount

Section 18. CsiDataSource Control Reference COM Return Values Table of Possible Values Code Meaning S_OK Success: Normal return E_CSI_ARRAY_OUT_OF_B

Section 18. CsiDataSource Control Reference 18.6 RecordCollection 18.6.1 Properties RecordCollection.Count Name RecordCollection.Count As Long Desc

Section 18. CsiDataSource Control Reference 18-30 18.7 Value Interface 18.7.1 Properties Value.columnName Name Value.columnName As String Descripti

Section 19. CsiLogMonitor Control Reference 19.1 LogMonitor Interface 19.1.1 Properties LogMonitor.commLogMonitorBusy Name LogMonitor.commLogMonito

Section 19. CsiLogMonitor Control Reference COM Return Values Table of Possible Values Code Meaning S_OK Success: Normal return E_CSI_INVALIDARG Er

Section 19. CsiLogMonitor Control Reference COM Return Values Table of Possible Values Code Meaning S_OK Success: Normal return E_CSI_BUSY Error: T

Section 19. CsiLogMonitor Control Reference COM Return Values Table of Possible Values Code Meaning S_OK Success: Normal return E_CSI_BUSY Error: At

Section 19. CsiLogMonitor Control Reference COM Return Values Table of Possible Values Code Meaning S_OK Success: Normal return LogMonitor.tranLog

Section 1. LoggerNet Server SDK Overview 5. A confirmation message similar to one below will appear. Click on Yes. 6. A new window titled Informa

Section 19. CsiLogMonitor Control Reference COM Return Values Table of Possible Values Code Meaning S_OK Success: Normal return E_CSI_FAIL Error: U

Section 19. CsiLogMonitor Control Reference COM Return Values Table of Possible Values Code Meaning S_OK Success: Normal return E_CSI_FAIL Error: U

Section 19. CsiLogMonitor Control Reference LogMonitor.tranLogMonitorStop() Name LogMonitor.tranLogMonitorStop() Description This method will stop a

Section 19. CsiLogMonitor Control Reference Table of Possible failure codes. Enumeration Name Value Description lm_failure_unknown 0 Indicates t

Section 19. CsiLogMonitor Control Reference Description This event indicates there was an error with the connection to the LoggerNet server. This ev

Section 19. CsiLogMonitor Control Reference Description This event indicates an error has occurred while trying to retrieve transaction log entries f

Section 19. CsiLogMonitor Control Reference 19-12

Appendix A. Server and Device Operational Statistics Tables The LoggerNet server and devices in the network map maintain statistics that help to desc

Appendix A. Server and Device Operational Statistics Tables Description: Records the total number of retires that the device experienced during the te

Appendix A. Server and Device Operational Statistics Tables Applies To: All Device Types Description: A running total of the number of communication

Section 2. CsiServer Control 2.1 Purpose of the CsiServer Control The CsiServer Control allows the user to start and stop the included, LoggerNet se

Appendix A. Server and Device Operational Statistics Tables A.2.10 Collection Enabled Column Name: “Collection Enabled” Column Definition Description

Appendix A. Server and Device Operational Statistics Tables Applies To: 21X, CR7X, CR10, CR10X, CR500, CR510, CR23X, CR10T, CR10X-TD, CR510-TD, CR23X

Appendix A. Server and Device Operational Statistics Tables Applies To: 21X, CR7X, CR10, CR10X, CR500, CR510, CR23X, CR10T, CR10X-TD, CR510-TD, CR23X-

Appendix A. Server and Device Operational Statistics Tables A.2.20 Polling Active Column Name: “Polling Active” Column Definition Description: “Poll

Appendix A. Server and Device Operational Statistics Tables Type: uint4 Applies To: 21X, CR7, CR10, CR10X, CR500, CR510, CR23X Description: Relays the

Appendix A. Server and Device Operational Statistics Tables shut itself down because its supply voltage has been to low. This information is read fr

Appendix A. Server and Device Operational Statistics Tables A-10 There is only one row defined for the table. The statistics available in this table

Campbell Scientific Companies Campbell Scientific, Inc. (CSI) 815 West 1800 North Logan, Utah 84321 UNITED STATES www.campbellsci.com • info@campbel

Section 2. CsiServer Control 2-2 2.2.1 Properties • applicationWorkDir As String • buildDate As String (read-only) • logFileDir As String • serv

Section 3. Developing an Application Using the CsiServer Control 3.1 Purpose This section shows by example how to build an application using the SDK

Section 3. Developing an Application Using the CsiServer Control CsiLogMonitor 1.0 Type Library CsiServer 1.0 Type Library Check the box next to the

Section 3. Developing an Application Using the CsiServer Control In order to stop the LoggerNet server, use the method stopServer(). A basic example

Section 3. Developing an Application Using the CsiServer Control 3-4

Section 4. CsiCoraScript Control 4.1 Purpose of the CsiCoraScript Control The CsiCoraScript control provides the power to administer the LoggerNet s

Section 4. CsiCoraScript Control 4.3.1 Setting up a Network Some of the commands that can be used when initially setting up a datalogger network on

Section 4. CsiCoraScript Control 4.3.2.1 Table-Data Dataloggers The LoggerNet server, by default, creates a collect area for the Public or InLocs ta

Section 4. CsiCoraScript Control 4-4 Collect area names must always be unique. Therefore, if an attempt is made to create a collect area with exactl

Section 5. Developing an Application Using the CsiCoraScript Control 5.1 Purpose This section shows an example of how to build an application using

Section 5. Developing an Application Using the CsiCoraScript Control Check the box next to the CsiCoraScript 1.0 Type Library, click Apply, and then

Section 5. Developing an Application Using the CsiCoraScript Control Private Sub cmdConnect_Click() 'Connect using the default logon settings. C

Campbell Scientific, Inc. Software SDK End User License Agreement (EULA) NOTICE OF AGREEMENT: Please carefully read this EULA. By installing or using

Section 5. Developing an Application Using the CsiCoraScript Control 5-4

Section 6. CsiBrokerMap Control 6.1 Purpose of the CsiBrokerMap Control The CsiBrokerMap control gives developers access to the broker map, which is

Section 6. CsiBrokerMap Control 6.3 How Collections Work The CsiBrokerMap uses the concept of collections in its implementation. Collections provide

Section 6. CsiBrokerMap Control 6.4 CsiBrokerMap Interfaces The following interfaces are included in the CsiBrokerMap control: • Broker • Broker

Section 6. CsiBrokerMap Control 6.4.2.2 Methods • item(id) As Broker • _NewEnum() (GetEnumerator() in .NET) 6.4.3 Broker Interface See the Refer

Section 6. CsiBrokerMap Control 6.4.6 ColumnCollection Interface See the Reference Section for descriptions of these properties and methods. 6.4.6.

Section 6. CsiBrokerMap Control 6-6

Section 7. Developing an Application Using the CsiBrokerMap Control 7.1 Purpose This section shows by example how to build an application using the

Section 7. Developing an Application Using the CsiBrokerMap Control 2. Start a new project (File | New Project | Standard EXE | OK). This will open

Section 7. Developing an Application Using the CsiBrokerMap Control Now that the interface has been designed, the code can be organized to accomplish

7) If the software program you develop requires you, your customer, or a third party to use additional licensable software from Campbell Scientific,

Section 7. Developing an Application Using the CsiBrokerMap Control 7-4 "." & t.Name & "." & c.Name, c.Name)

Section 8. CsiDatalogger 8.1 Purpose of the CsiDatalogger Control The CsiDatalogger control allows the developer to manage datalogger functions thro

Section 8. CsiDatalogger 8-2 8.3.2 Methods • clockCancel() • clockCheckStart() • clockSetStart() • loggerConnectCancel() • loggerConnectStart(l

Section 9. Developing an Application Using the Datalogger Control 9.1 Purpose This section illustrates the use of the CsiDatalogger control. This c

Section 9. Developing an Application Using the Datalogger Control 2. Start a new project (File | New Project | Standard EXE | OK). This will open a

Section 9. Developing an Application Using the Datalogger Control Now that the interface has been designed, the code can be organized to accomplish t

Section 9. Developing an Application Using the Datalogger Control Private Sub cmdDataloggerConnect_Click() 'Create an active connection to the

Section 9. Developing an Application Using the Datalogger Control Private Sub cmdCheck_Click() 'Check the clock on the datalogger. If DataLo

Section 9. Developing an Application Using the Datalogger Control Private Sub cmdDataStart_Click() 'Begin a manual poll to retrieve data If

Section 9. Developing an Application Using the Datalogger Control Private Sub cmdRetrieve_Click() 'Get the current program from the datalogger

application. This information should appear on the first window the user will see. WARRANTIES: The following warranties are in effect for ninety (90)

Section 9. Developing an Application Using the Datalogger Control 9-8

Section 10. CsiDataSource Control 10.1 Purpose of the CsiDataSource Control The CsiDataSource control allows an application to monitor data collecte

Section 10. CsiDataSource Control 10.3 CsiDataSource Interfaces The following interfaces are used in the CsiDataSource control: • DSource – the con

Section 10. CsiDataSource Control 10.3.2.1 Properties • advisorName As String • orderOption As csidsOrderOptionType • startDate As Date • startF

Section 10. CsiDataSource Control 10-4 10.3.5 Record See the Reference Section for descriptions of these properties, methods, and events. 10.3.5.1

Section 11. Developing an Application Using the CsiDataSource Control 11.1 Purpose The CsiDataSource control primarily monitors data residing in the

Section 11. Developing an Application Using the CsiDataSource Control 3. View the toolbox for this new project (VB 6 Main Menu | View | Toolbox). 4

Section 11. Developing an Application Using the CsiDataSource Control Now that the interface has been designed, the code can be organized to accompli

Section 11. Developing an Application Using the CsiDataSource Control 11-4 Private Sub DSource_onAdviseRecord(ByVal myAdvisor As Object, _ ByVal myRe

Section 12. CsiLogMonitor Control 12.1 Purpose of the CsiLogMonitor Control The CsiLogMonitor Control provides access to log message from the Logger

There is no written or implied warranty provided with the LoggerNet Server SDK software other than as stated herein. Developer agrees to bear all war

Section 12. CsiLogMonitor Control 12-2 12.2 CsiLogMonitor Interface See the Reference section in this manual for detailed descriptions of these prop

Section 13. Developing an Application Using the CsiLogMonitor Control 13.1 Purpose This section shows an example of how to build an application usin

Section 13. Developing an Application Using the CsiLogMonitor Control Check the box next to the CsiLogMonitor 1.0 Type Library, click Apply, and clos

Section 13. Developing an Application Using the CsiLogMonitor Control Private Sub cmdConnect_Click() 'Connect using the default logon settings.

Section 13. Developing an Application Using the CsiLogMonitor Control 13-4 Stop monitoring logs with the commLogMonitorStop() and tranLogMonitorStop(

Section 14. CsiServer Control Reference 14.1 Server Interface 14.1.1 Properties Server.applicationWorkDir Name Server.applicationWorkDir As String

Section 14. CsiServer Control Reference Server.logFileDir Name Server.logFileDir As String Description This property specifies the location where th

Section 14. CsiServer Control Reference COM Return Values Table of Possible Values Code Meaning S_OK Success: Normal return E_CSI_FAIL Error: Unexp

Section 14. CsiServer Control Reference Server.tcpPortEx Name Server.tcpPortEx As Long Description This property sets the TCP port that the LoggerNet

Section 14. CsiServer Control Reference Server.stopServer() Name Server.stopServer() Description This method will stop the limited LoggerNet server

LoggerNet Server Software Development Kit Table of Contents PDF viewers note: These page numbers refer to the printed version of this document. Use t

Section 14. CsiServer Control Reference 14-6

Section 15. CsiCoraScript Control Reference 15.1 CoraScript Interface 15.1.1 Properties CoraScript.serverConnected Name CoraScript.serverConnected

Section 15. CsiCoraScript Control Reference CoraScript.serverLogonPassword Name CoraScript.serverLogonPassword As String Valid Values If security is

Section 15. CsiCoraScript Control Reference CoraScript.serverPort Name CoraScript.serverPort As Long Description Specifies the TCP port number that

Section 15. CsiCoraScript Control Reference CoraScript.serverConnect() Name CoraScript.serverConnect() Description This method attempts to connect t

Section 15. CsiCoraScript Control Reference CoraScript_onServerConnectStarted() Name onServerConnectStarted() Description The control has connected t

Section 15. CsiCoraScript Control Reference 15-6

Section 16. CsiBrokerMap Control Reference 16.1 BrokerMap Interface 16.1.1 Properties BrokerMap.serverName Name BrokerMap.serverName As String Desc

Section 16. CsiBrokerMap Control Reference COM Return Values Table of Possible Values Code Meaning S_OK Success: Normal return E_CSI_BUSY Error: At

Section 16. CsiBrokerMap Control Reference COM Return Values Table of Possible Values Code Meaning S_OK Success: Normal return E_CSI_BUSY Error: At

LoggerNet Software Development Kit Table of Contents 4.4 CsiCoraScript Interface...

Section 16. CsiBrokerMap Control Reference COM Return Values Table of Possible Values Code Meaning S_OK Success: Normal Return 16.1.2 Methods Broke

Section 16. CsiBrokerMap Control Reference COM Return Values Table of Possible Values Code Meaning S_OK Success: Normal return E_CSI_ALREADY_CONNECT

Section 16. CsiBrokerMap Control Reference BrokerMap_onFailure() Name onFailure(BrokerMapFailureType failure_code) Description When the BrokerMap co

Section 16. CsiBrokerMap Control Reference BrokerMap_onTableDeleted() Name onTableDeleted(Object Broker, Object Table) Description This event gets c

Section 16. CsiBrokerMap Control Reference 16.2.2 Methods BrokerCollection.Item() Name BrokerCollection.Item(id) As Broker Description A Broker can

Section 16. CsiBrokerMap Control Reference BrokerCollection._NewEnum() Name BrokerCollection._NewEnum() — Return the next broker in the broker map se

Section 16. CsiBrokerMap Control Reference COM Return Values Table of Possible Values Code Meaning S_OK Success: Normal return. Broker.type Name B

Section 16. CsiBrokerMap Control Reference COM Return Values Table of Possible Values Code Meaning S_OK Success: Normal return Broker.allStarted Nam

Section 16. CsiBrokerMap Control Reference COM Return Values Table of Possible Values Code Meaning S_OK Success: Normal Return 16.4 TableCollection

Section 16. CsiBrokerMap Control Reference COM Return Values Table of Possible Values Code Meaning S_OK Success: Normal return E_CSI_ARRAY_OUT_OF_BO

LoggerNet Software Development Kit Table of Contents 8. CsiDatalogger ...8-1 8.1 Purpose of

Section 16. CsiBrokerMap Control Reference 16.5 Table Interface 16.5.1 Properties Table.interval Name Table.interval As Long Description The time

Section 16. CsiBrokerMap Control Reference COM Return Values Table of Possible Values Code Meaning S_OK Success: Normal return Table.size Name Tabl

Section 16. CsiBrokerMap Control Reference Table.start_expansion Name Table.start_expansion() Description If the BrokerMap autoExpand property has be

Section 16. CsiBrokerMap Control Reference Prototypes ColumnCollection.Item(Number) - Array index. ColumnCollection.Item(String) - Table name. COM R

Section 16. CsiBrokerMap Control Reference 16.7 Column Interface 16.7.1 Properties Column.description Name Column.description As String Description

Section 16. CsiBrokerMap Control Reference COM Return Values Table of Possible Values Code Meaning S_OK Success: Normal return Column.type Name Col

Section 16. CsiBrokerMap Control Reference Name Value Description dt_CsiAscii 11 fixed-length string dt_CsiAsciiZ 16 null-terminated variable-

Section 16. CsiBrokerMap Control Reference Column.writable Name Column.writable As Long Description This property is read-only and describes whether

Section 16. CsiBrokerMap Control Reference 16-22

Section 17. CsiDatalogger Control Reference 17.1 Datalogger Interface 17.1.1 Properties Datalogger.clockBusy Name Datalogger.clockBusy As Boolean