Function Blocks ¶ Close (FunctionBlock) Open (FunctionBlock) Read (FunctionBlock) Write (FunctionBlock)
Close (FB) ¶ FUNCTION_BLOCK Close EXTENDS CBM.ETrig Close a serial com port opened via the FB COM. Open . The output handle hCom must be used here to close the COM port! InOut: Scope Name Type Comment Input hCom CAA.HANDLE Handle to the open COM port. Ist returned by the COM. Open function block. Output eError ERROR Local library error ID (0: no error; 5001: time out)
Open (FB) ¶ FUNCTION_BLOCK Open EXTENDS CBM.ETrig Open a serial com port. The input Parameter s are a list of settings, with which the COM port should be opened. Example: COMPort = 1, Baudrate = 115200, Parity = None, StopBit s = 1 DECLARATION: MyComOpen : COM.Open ; aParamsB115200 : ARRAY [1..7] OF COM.PARAMETER := [ (udiParameterId := COM.CAA_Parameter_Constants.udiPort, udiValue := 1), (udiParameterId := COM.CAA_Parameter_Constants.udiBaudrate, udiValue := 115200), (udiParameterId := COM.CAA_Parameter_Constants.udiParity, udiValue := COM.PARITY.NONE), (udiParameterId := COM.CAA_Parameter_Constants.udiStopBits, udiValue := COM.STOPBIT.ONESTOPBIT), (udiParameterId := COM.CAA_Parameter_Constants.udiTimeout, udiValue := 0), (udiParameterId := COM.CAA_Parameter_Constants.udiByteSize, udiValue := 8), (udiParameterId := COM.CAA_Parameter_Constants.udiBinary, udiValue := 1) ] ; IMPLEMENTATION: So to parameterize the FB looks like: MyComOpen ( usiListLength := SIZEOF ( aParamsB115200 )/ SIZEOF ( COM.PARAMETER ), pParameterList := ADR ( aParamsB115200 )); ... InOut: Scope Name Type Comment Input usiListLength USINT Number of entries in the pParameterList pParameterList CAA.PVOID Pointer to ARRAY of parameter entries Output eError ERROR Local library error ID (0: no error; 5001: time out) hCom CAA.HANDLE specific Outputs
IBACnetServerPlugin.PostRegister (METH) ¶ METHOD PostRegister : UDINT Initialization, gets called during BACNetServer.RegisterPlugin after application service hooks/callbacks are registered. Return CmpErrors.Errors.ERR_OK if successfully. InOut: Scope Name Type Return PostRegister UDINT
Read (FB) ¶ FUNCTION_BLOCK Read EXTENDS CBM.ETrigToA Function block to read data from the serial port InOut: Scope Name Type Comment Input hCom CAA.HANDLE Handle to the open COM port. Ist returned by the COM. Open function block. pBuffer CAA.PVOID Pointer to a buffer to get the received data from the COM port szBuffer CAA.SIZE Maximum size of the pBuffer parameter in bytes Output eError ERROR Local library error ID (0: no error; 5001: time out) szSize CAA.SIZE Returns the number of received data bytes in pBuffer
Write (FB) ¶ FUNCTION_BLOCK Write EXTENDS CBM.ETrigToA Function block to write data to the serial port InOut: Scope Name Type Comment Input hCom CAA.HANDLE Handle to the open COM port. Ist returned by the COM. Open function block. pBuffer CAA.PVOID Pointer to a buffer with the data to write to the COM port szSize CAA.SIZE Number of bytes in pBuffer to write to the COM port Output eError ERROR Local library error ID (0: no error; 5001: time out)
CAA Storage Library Documentation ¶ Company CAA Technical Workgroup Title CAA Storage Version 3.5.13.0 Categories Intern|CAA|Database Namespace STO Author 3S - Smart Software Solutions GmbH Placeholder CAA Storage Description 1 ¶ Library for efficent read/write acces of stuctured data stored outside the main memory Contents: ¶ CAA Storage Functions Interfaces Structs Types CAAStorageVersionConstants (GVL) GetSupplierVersion (Function) VersionConstants (GVL) Indices and tables ¶ 1 Based on CAA_Storage.library, last modified 03.07.2018, 09:55:02. LibDoc 4.4.0.0-b.27 The content file CAA_Storage.clean.json was generated with CODESYS V3.5 SP13 on 03.07.2018, 09:55:11.
IBACnetServerPlugin.PostStopBACnetStack (METH) ¶ METHOD PostStopBACnetStack : UDINT Gets called prior of BACnetServer.StopBACnetStack . Return CmpErrors.Errors.ERR_OK if successfully. InOut: Scope Name Type Return PostStopBACnetStack UDINT
CAA Storage ¶ Functions BLOB BlobAlloc (Function) BlobCopyToData (Function) BlobFree (Function) DataCopyToBlob (Function) ISO8601 DT_TO_INT64 (Function) DT_TO_ISO8601 (Function) DT_TO_REAL8 (Function) INT64_TO_DT (Function) INT64_TO_ISO8601 (Function) INT64_TO_LTIME (Function) INT64_TO_REAL8 (Function) INT64_TO_TIME (Function) ISO8601_TO_DT (Function) ISO8601_TO_LTIME (Function) ISO8601_TO_TIME (Function) LTIME_TO_INT64 (Function) LTIME_TO_ISO8601 (Function) LTIME_TO_REAL8 (Function) REAL8_TO_DT (Function) REAL8_TO_LTIME (Function) REAL8_TO_TIME (Function) TIME_TO_INT64 (Function) TIME_TO_ISO8601 (Function) TIME_TO_REAL8 (Function) TEXT CreateTextFromString (Function) CreateTextFromWString (Function) TextCopyToString (Function) TextCopyToWString (Function) TextFree (Function) TIMEZONE INT64_TO_LOCALTIME (Function) INT64_TO_UTC (Function) Interfaces AsyncStorage ICursorAsync (Interface) Cursor CursorCloseAsync (Method) CursorMoveAsync (Method) Searching CursorSearchRowIdAsync (Method) CursorSearch_DINTAsync (Method) CursorSearch_INTAsync (Method) CursorSearch_LINTAsync (Method) CursorSearch_LREALAsync (Method) CursorSearch_NULLAsync (Method) CursorSearch_REALAsync (Method) CursorSearch_SINTAsync (Method) CursorSearch_TEXTAsync (Method) IRowAsync (Interface) Row RowUpdateAsync (Method) IRowPlanchetAsync (Interface) Row RowInsertAsync (Method) IStorageAsync (Interface) Storage StorageClearAsync (Method) StorageCloseAsync (Method) StorageReorgAsync (Method) Table TableOpenAsync (Method) Transaction TransactionBeginAsync (Method) ITableAsync (Interface) Cursor CursorOpenAsync (Method) Row RowDeleteAsync (Method) RowSelectAsync (Method) Table TableClearAsync (Method) TableCloseAsync (Method) AsyncTransaction ISavepointAsync (Interface) Savepoint SavepointReleaseAsync (Method) SavepointRollbackAsync (Method) ITransactionAsync (Interface) Savepoint TransactionSetSavepointAsync (Method) Transaction TransactionCommitAsync (Method) TransactionRollbackAsync (Method) Storage ICursor (Interface) Cursor CursorClose (Method) CursorCurrentRow (Property) CursorIndexId (Property) CursorIsReadOnly (Property) CursorMove (Method) CursorStorage (Property) CursorTable (Property) Searching CursorSearchRowId (Method) CursorSearch_DINT (Method) CursorSearch_INT (Method) CursorSearch_LINT (Method) CursorSearch_LREAL (Method) CursorSearch_NULL (Method) CursorSearch_REAL (Method) CursorSearch_SINT (Method) CursorSearch_TEXT (Method) ICursor2 (Interface) Searching CursorSearchRowId2 (Method) ICursor3 (Interface) LastError (Property) IRow (Interface) Row RowHasChanged (Property) RowId (Property) RowUpdate (Method) IRow2 (Interface) Row GetRowId (Method) IRow3 (Interface) LastError (Property) IRowBase (Interface) Column ColumnGetType (Method) Get Value ColumnGet_BLOB (Method) ColumnGet_DINT (Method) ColumnGet_INT (Method) ColumnGet_LINT (Method) ColumnGet_LREAL (Method) ColumnGet_REAL (Method) ColumnGet_SINT (Method) ColumnGet_TEXT (Method) Set Value ColumnSet_BLOB (Method) ColumnSet_DINT (Method) ColumnSet_INT (Method) ColumnSet_LINT (Method) ColumnSet_LREAL (Method) ColumnSet_NULL (Method) ColumnSet_REAL (Method) ColumnSet_SINT (Method) ColumnSet_TEXT (Method) Update Value ColumnUpdate_BLOB (Method) ColumnUpdate_DINT (Method) ColumnUpdate_INT (Method) ColumnUpdate_LINT (Method) ColumnUpdate_LREAL (Method) ColumnUpdate_REAL (Method) ColumnUpdate_SINT (Method) ColumnUpdate_TEXT (Method) Row RowClear (Method) RowNumOfColumns (Property) RowRelease (Method) RowStorage (Property) RowTable (Property) IRowPlanchet (Interface) Row RowInsert (Method) IStorage (Interface) Storage StorageClear (Method) StorageClose (Method) StorageEncoding (Property) StorageGetMetrics (Method) StorageGetPath (Method) StorageIsReadOnly (Property) StorageLockingState (Property) StorageNumOfTables (Property) StorageReorg (Method) StorageSchemaVersion (Property) StorageUserVersion (Property) StorageVersion (Property) Table TableOpen (Method) Transaction TransactionBegin (Method) Utilities UtilityGetCurrentDateAndTime (Method) UtilityRandomness (Method) IStorage2 (Interface) StorageGetIndexId (Method) StorageGetTableId (Method) ITable (Interface) Cursor CursorOpen (Method) Row RowCreate (Method) RowDelete (Method) RowDuplicate (Method) RowSelect (Method) Table TableClear (Method) TableClose (Method) TableId (Property) TableNumOfColumns (Property) TableNumOfIndexes (Property) TableNumOfRows (Property) TableStorage (Property) ITable2 (Interface) Row RowDelete2 (Method) ITable3 (Interface) LastError (Property) ITable4 (Interface) GetMinMaxRowIds (Method) Transaction ISavepoint (Interface) Savepoint SavepointRelease (Method) SavepointRollback (Method) SavepointStorage (Property) SavepointTransaction (Property) ITransaction (Interface) Savepoint TransactionSetSavepoint (Method) Transaction TransactionCommit (Method) TransactionRollback (Method) TransactionStorage (Property) Structs BLOB (Alias) METRICS (Alias) STO_BLOB (Struct) STO_METRICS (Struct) STO_TEXT (Struct) TEXT (Alias) Types INT64 (Alias) ISO8601 (Alias) REAL8 (Alias) SQLSTATEMENT (Alias)
Functions ¶ BLOB BlobAlloc (Function) BlobCopyToData (Function) BlobFree (Function) DataCopyToBlob (Function) ISO8601 DT_TO_INT64 (Function) DT_TO_ISO8601 (Function) DT_TO_REAL8 (Function) INT64_TO_DT (Function) INT64_TO_ISO8601 (Function) INT64_TO_LTIME (Function) INT64_TO_REAL8 (Function) INT64_TO_TIME (Function) ISO8601_TO_DT (Function) ISO8601_TO_LTIME (Function) ISO8601_TO_TIME (Function) LTIME_TO_INT64 (Function) LTIME_TO_ISO8601 (Function) LTIME_TO_REAL8 (Function) REAL8_TO_DT (Function) REAL8_TO_LTIME (Function) REAL8_TO_TIME (Function) TIME_TO_INT64 (Function) TIME_TO_ISO8601 (Function) TIME_TO_REAL8 (Function) TEXT CreateTextFromString (Function) CreateTextFromWString (Function) TextCopyToString (Function) TextCopyToWString (Function) TextFree (Function) TIMEZONE INT64_TO_LOCALTIME (Function) INT64_TO_UTC (Function)