pascalSCADA OPM: s7family: Class TSiemensProtocolFamily

	`function GetTagInfo(tagobj:TTag):TTagRec; virtual;`
	`procedure SetBytes(Ptr:PByte; idx:LongInt; values:BYTES);`
	`function initAdapter:Boolean; virtual;`
	`function disconnectAdapter:Boolean; virtual;`
	`function connectPLC(var CPU:TS7CPU):Boolean; virtual;`
	`function disconnectPLC(var CPU:TS7CPU):Boolean; virtual;`
	`function exchange(var CPU:TS7CPU; var msgOut:BYTES; var msgIn:BYTES; IsWrite:Boolean):Boolean; virtual;`
	`procedure sendMessage(var msgOut:BYTES); virtual;`
	`function getResponse(var msgIn:BYTES; var BytesRead:LongInt):TIOResult; virtual;`
	`function SwapBytesInWord(W:Word):Word;`
	`procedure PrepareToSend(var msg:BYTES); virtual;`
	`procedure AddParam(var MsgOut:BYTES; const param:BYTES); virtual;`
	`procedure AddData(var MsgOut:BYTES; const data:BYTES); virtual;`
	`procedure InitiatePDUHeader(var MsgOut:BYTES; PDUType:LongInt); virtual;`
	`function NegotiatePDUSize(var CPU:TS7CPU):Boolean; virtual;`
	`function SetupPDU(var msg:BYTES; MsgOutgoing:Boolean; out PDU:TPDU; out error:integer):Boolean; virtual;`
	`procedure PrepareReadRequest(var msgOut:BYTES); virtual;`
	`procedure PrepareWriteRequest(var msgOut:BYTES); virtual;`
	`procedure PrepareReadOrWriteRequest(const WriteRequest:Boolean; var msgOut:BYTES); virtual;`
	`procedure AddToReadRequest(var msgOut:BYTES; iArea, iDBnum, iStart, iByteCount:LongInt); virtual;`
	`procedure AddParamToWriteRequest(var msgOut:BYTES; iArea, iDBnum, iStart:LongInt; buffer:BYTES); virtual;`
	`procedure AddDataToWriteRequest(var msgOut:BYTES; iArea, iDBnum, iStart:LongInt; buffer:BYTES); virtual;`
	`procedure RunPLC(CPU:TS7CPU);`
	`procedure StopPLC(CPU:TS7CPU);`
	`function S7ErrorCodeToProtocolErrorCode(code:Word):TProtocolIOResult;`
	`function DoublesToBytes(const Values:TArrayOfDouble; Start, Len:LongInt):BYTES;`
	`function BytesToDoubles(const ByteSeq:BYTES; Start, Len:LongInt):TArrayOfDouble;`
	`function CreatePLC(iRack, iSlot, iStation:LongInt):LongInt; virtual;`
	`procedure DeletePLC(PLCIndex:Integer); virtual;`
	`procedure UpdateMemoryManager(pkgin, pkgout:BYTES; writepkg:Boolean; ReqList:TS7ReqList; var ResultValues:TArrayOfDouble);`
	`procedure DoAddTag(TagObj:TTag; TagValid:Boolean); override;`
	`procedure DoDelTag(TagObj:TTag); override;`
	`procedure DoScanRead(Sender:TObject; var NeedSleep:LongInt); override;`
	`procedure DoGetValue(TagRec:TTagRec; var values:TScanReadRec); override;`
	`function DoWrite(const tagrec:TTagRec; const Values:TArrayOfDouble; Sync:Boolean):TProtocolIOResult; override;`
	`function DoRead(const tagrec:TTagRec; out Values:TArrayOfDouble; Sync:Boolean):TProtocolIOResult; override;`
	`function SizeOfTag(aTag:TTag; isWrite:Boolean; var ProtocolTagType:TProtocolTagType):BYTE; override;`
	`function LiteralTagAddress(aTag: TTag; aBlockTag: TTag=nil):AnsiString; override;`
	`procedure OpenTagEditor(InsertHook: TAddTagInEditorHook; CreateProc: TCreateTagProc); override;`
	`function HasTabBuilderEditor: Boolean; override;`

Properties

property ReadSomethingAlways;

Description

Fields

	`PDUIncoming:LongInt;`
: Where PDU starts on incoming and outgoing packets.

	`PDUOutgoing:LongInt;`
: Where PDU starts on incoming and outgoing packets.

FPLCs:TS7CPUs;

: Lists all CPU's being read by the protocol driver.

Methods

	`function GetTagInfo(tagobj:TTag):TTagRec; virtual;`
: Returns a structure with informations about the tag.

	`procedure SetBytes(Ptr:PByte; idx:LongInt; values:BYTES);`
: Gets a byte from a pointer of bytes. function GetByte(Ptr:PByte; idx:LongInt):LongInt; : Sets a byte in a pointer of bytes. procedure SetByte(Ptr:PByte; idx:LongInt; value:Byte); : Sets a lot of bytes in a pointer of bytes.

	`function initAdapter:Boolean; virtual;`
: Initializes the adapter, if needed.

	`function disconnectAdapter:Boolean; virtual;`
: Disconnects from adapter.

function connectPLC(var CPU:TS7CPU):Boolean; virtual;

: Connects on a PLC.

Parameters

CPU: TS7CPU. Represents the PLC to connect.

function disconnectPLC(var CPU:TS7CPU):Boolean; virtual;

: Disconnects from a PLC.

Parameters

CPU: TS7CPU. Represents the PLC to disconnect.

function exchange(var CPU:TS7CPU; var msgOut:BYTES; var msgIn:BYTES; IsWrite:Boolean):Boolean; virtual;

: Exchange data with a PLC.

Parameters

CPU: TS7CPU. PLC to exchange data.
msgOut: BYTES. Packet to send to PLC.
msgIn: BYTES. Stores the received packet from PLC.
IsWrite: Boolean. Tells if the message to be send to PLC will write in PLC memory.

Returns

True if successful.

procedure sendMessage(var msgOut:BYTES); virtual;

: Sends a message.

Parameters

msgOut: BYTES. Message to send.

function getResponse(var msgIn:BYTES; var BytesRead:LongInt):TIOResult; virtual;

: Gets a incoming packet from the communication port.

Parameters

msgIn: BYTES. Stores the incoming packet.
BytesRead: LongInt. Packet length.

Returns

iorOK if was come some packet.

function SwapBytesInWord(W:Word):Word;

: Swap the bytes of a word.

Parameters

W: Word. Word to swap their bytes.

Returns

The word with their bytes swaped.

procedure PrepareToSend(var msg:BYTES); virtual;

: Prepares a message to be sent.

Parameters

msg: BYTES. Message to be prepared.

procedure AddParam(var MsgOut:BYTES; const param:BYTES); virtual;

: Adds a parameter into the message to be sent.

Parameters

MsgOut: BYTES. Message to be sent.
param: BYTES. Parameter to be added.

procedure AddData(var MsgOut:BYTES; const data:BYTES); virtual;

: Adds a dataset into the message to be sent.

Parameters

MsgOut: BYTES. Message to be sent.
data: BYTES. Data to be added.

procedure InitiatePDUHeader(var MsgOut:BYTES; PDUType:LongInt); virtual;

: Initialize the PDU on outgoing message.

Parameters

MsgOut: BYTES. Outgoing message to initiate the PDU.
PDUType: LongInt. Kind of PDU to create.

function NegotiatePDUSize(var CPU:TS7CPU):Boolean; virtual;

: Negotiate the maximum PDU size.

Parameters

CPU: TS7CPU. PLC to negotiate the maximum PDU size.

function SetupPDU(var msg:BYTES; MsgOutgoing:Boolean; out PDU:TPDU; out error:integer):Boolean; virtual;

: Creates a PDU structure from message.

Parameters

msg: BYTES. Menssage to get the PDU structure.
MsgOutgoing: Boolean. If True the message will be sent to PLC, if not the message is comming from the PLC.
PDU: TPDU. The PDU structure extracted from message.

Returns

The error number of PDU, if exists.

procedure PrepareReadRequest(var msgOut:BYTES); virtual;

: Prepares the message to do a memory read request from PLC.

Parameters

msgOut: BYTES. Message to be sent to PLC requesting a memory read.

procedure PrepareWriteRequest(var msgOut:BYTES); virtual;

: Prepares the message to write data into the PLC memory.

Parameters

msgOut: BYTES. Message to sent to write data into the PLC memory.

procedure PrepareReadOrWriteRequest(const WriteRequest:Boolean; var msgOut:BYTES); virtual;

: Prepares the message to read or write on PLC.

Parameters

WriteRequest: Boolean. If True, the message will write something in PLC memory.
msgOut: BYTES. Message to be prepared to request a read/write.

procedure AddToReadRequest(var msgOut:BYTES; iArea, iDBnum, iStart, iByteCount:LongInt); virtual;

: Add into the outgoing message, informations about what must be read from PLC.

Parameters

msgOut: BYTES. Message to be sent to PLC requesting a memory read.
iArea: LongInt. Wanted memory area.
iDBnum: LongInt. If iArea is vtS7_DB, what's the DB number.
iStart: LongInt. Start address of memory.
iByteCount: LongInt. How many bytes to read.

procedure AddParamToWriteRequest(var msgOut:BYTES; iArea, iDBnum, iStart:LongInt; buffer:BYTES); virtual;

: Add into the outgoing message, informations about the data to be written on PLC.

Parameters

msgOut: BYTES. Message to be sent to write data on PLC.
iArea: LongInt. Wanted memory area.
iDBnum: LongInt. If iArea is vtS7_DB, what's the DB number.
iStart: LongInt. Start address of memory.
buffer: BYTES. Data to be written on PLC.

procedure AddDataToWriteRequest(var msgOut:BYTES; iArea, iDBnum, iStart:LongInt; buffer:BYTES); virtual;

: Add into the outgoing message the data to be written on PLC.

Parameters

msgOut: BYTES. Message to be sent to write data on PLC.
iArea: LongInt. Wanted memory area.
iDBnum: LongInt. If iArea is vtS7_DB, what's the DB number.
iStart: LongInt. Start address of memory.
buffer: BYTES. Data to be written on PLC.

	`procedure RunPLC(CPU:TS7CPU);`
: Put the PLC in RUN state, if possible. Don't work yet.

	`procedure StopPLC(CPU:TS7CPU);`
: Stops the PLC, if possible. Don't work yet.

	`function S7ErrorCodeToProtocolErrorCode(code:Word):TProtocolIOResult;`
: Converts a Siemens error code to a protocol error code.

function DoublesToBytes(const Values:TArrayOfDouble; Start, Len:LongInt):BYTES;

: Converts TArrayOfDouble to BYTES.

Parameters

Values: TArrayOfDouble. Array to be converted.
Start: LongInt. First element of Values to be converted.
Len: LongInt. How many elements to convert from Start.

Returns

Converted Array of BYTES.

function BytesToDoubles(const ByteSeq:BYTES; Start, Len:LongInt):TArrayOfDouble;

: Converts BYTES to TArrayOfDouble.

Parameters

ByteSeq: BYTES. Array of byte to be converted to Double.
Start: LongInt. First element of ByteSeq to be converted.
Len: LongInt. How many elements to convert from Start.

Returns

Array of TArrayOfDouble.

function CreatePLC(iRack, iSlot, iStation:LongInt):LongInt; virtual;

: Creates a PLC in the addressed PLC's list.

Parameters

iRack: LongInt. PLC Rack.
iSlot: LongInt. PLC Slot.
iStation: LongInt. PLC Address.

Returns

The PLC index on PLC list.

procedure DeletePLC(PLCIndex:Integer); virtual;

: Delete a PLC from the addressed PLC's list.

Parameters

PLCIndex: LongInt. Index of PLC in the PLC's list.

procedure UpdateMemoryManager(pkgin, pkgout:BYTES; writepkg:Boolean; ReqList:TS7ReqList; var ResultValues:TArrayOfDouble);

: Updates the manager of non-continuous memory blocks.

Parameters

pkgin: BYTES. Message received from PLC
pkgout: BYTES. Message sent to PLC
writepkg: Boolean. If True, the packet sent will change the PLC memory.
ReqList: TS7ReqList. List of all requests sent.
ResultValues: TArrayOfDouble. Values of the last request.

procedure DoAddTag(TagObj:TTag; TagValid:Boolean); override;

Properties

property ReadSomethingAlways;

	`FAdapterInitialized:Boolean;`
: If the protocol needs to initialize the adapter, stores if it was initialized.

pascalSCADA OPM: s7family: Class TSiemensProtocolFamily

Pascal SCADA OPM

Class TSiemensProtocolFamily

Unit

Declaration

Description

Hierarchy

Overview

Fields

Methods

Properties

Description

Fields

See also

Methods

Parameters

Parameters

Parameters

Returns

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Returns

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Parameters

See also

See also

See also

See also

See also

See also

See also

See also

See also

See also

Properties

See also