Skip to content

P
proview
Commit 3a72aa92 authored by Claes Sjofors's avatar Claes Sjofors
Browse files
Options

Remote logg function remote_logg() added, and some doc added

parent 9265ec85
Hide whitespace changes
Inline Side-by-side
Showing with 384 additions and 84 deletions
remote/lib/remote/src/remote.h
View file @ 3a72aa92
......@@ -234,3 +234,6 @@ typedef struct {
int maxremao; /* Number of Ao in subsystem */
int maxremco; /* Number of Pi in subsystem */
} remnode_item;
pwr_tStatus remote_logg( int identity, char *str, int size);
remote/lib/remote/src/remote_logg.c 0 → 100644
View file @ 3a72aa92
/*
* Proview Open Source Process Control.
* Copyright (C) 2005-2013 SSAB EMEA AB.
*
* This file is part of Proview.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License as
* published by the Free Software Foundation, either version 2 of
* the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with Proview. If not, see <http://www.gnu.org/licenses/>
*
* Linking Proview statically or dynamically with other modules is
* making a combined work based on Proview. Thus, the terms and
* conditions of the GNU General Public License cover the whole
* combination.
*
* In addition, as a special exception, the copyright holders of
* Proview give you permission to, from the build function in the
* Proview Configurator, combine Proview with modules generated by the
* Proview PLC Editor to a PLC program, regardless of the license
* terms of these modules. You may copy and distribute the resulting
* combined work under the terms of your choice, provided that every
* copy of the combined work is accompanied by a complete copy of
* the source code of Proview (the version used to produce the
* combined work), being distributed under the terms of the GNU
* General Public License plus this exception.
*/
#include "pwr.h"
#include "co_time.h"
#include "rt_qcom.h"
#include "pwr_remoteclasses.h"
#include "remote.h"
pwr_tStatus remote_logg( int identity, char *str, int size)
{
qcom_sPut put;
qcom_sQid qid;
char *logmsg;
char timstr[26];
int logsize = size + 5 + sizeof(timstr);
pwr_tStatus sts;
time_AtoAscii( 0, time_eFormat_DateAndTime,
timstr, sizeof(timstr));
logmsg = malloc(logsize);
*(int *)logmsg = identity;
strcpy( &logmsg[4], timstr);
strcat( &logmsg[4], " ");
strncat( &logmsg[4], str, size+1);
put.data = logmsg;
put.size = logsize;
put.type.b = qcom_eBtype__;
put.type.s = qcom_eStype__;
put.reply.qix = 0;
put.reply.nid = 0;
qid = qcom_cNQid;
qid.qix = rs_pwr_logg_qix;
sts = qcom_Put(&sts, &qid, &put);
free(logmsg);
return sts;
}
remote/wbl/remote/src/remote_c_loggconfig.wb_load
View file @ 3a72aa92
......@@ -33,9 +33,66 @@
! combined work), being distributed under the terms of the GNU
! General Public License plus this exception.
!
! remote_c_LoggConfig.wb_load -- Defines the class LoggConfig.
! remote_c_loggconfig.wb_load -- Defines the class LoggConfig.
!
SObject Remote:Class
!/**
! @Version 1.0
! @Group Servers,NodeConfiguration
! @Summary Configures logging of remote messages and other logging.
! Configures logging of remote messages and other logging.
!
! @b Remote logging
! Remote messages can be logged to file by setting LoggLevel in the
! RemTrans object to a value between 1 and 4.
!
! LoggLevel Description
!
! 0 No logging.
! 1 Logging of time, message lenght and status when an error
! has occured.
! 2 Logging of time, message lenght and status for every message.
! 3 Logging of time, length, status and the first 48 bytes
! in hexadecimal code.
! 4 Logging of time, length, status and the whole message
! in hex code.
!
! The Identity for a LoggConfig object handling the remote logging should
! be set to 90.
!
! @ Other logging
! Other loggings can be made by sending a QCom message to queue
! rs_pwr_logg_qix. The first 32-bit word in the message should be the
! Identity of the LoggConfig object, and the following data the string
! to be logged.
!
! @b Example Logging to LoggConfig with Identity 100
!
! qcom_sPut put;
! qcom_sQid qid;
! char *logmsg;
! int logsize = 80;
! int identity = 100;
! pwr_tStatus sts;
!
! logmsg = malloc(logsize);
! *(int *)logmsg = identity;
! strcpy( &logmsg[4], "Some message");
! put.data = logmsg;
! put.size = logsize;
! put.type.b = qcom_eBtype__;
! put.type.s = qcom_eStype__;
! put.reply.qix = 0;
! put.reply.nid = 0;
! qid = qcom_cNQid;
! qid.qix = rs_pwr_logg_qix;
! qcom_Put(&sts, &qid, &put);
!
! free(logmsg);
!
! @b See also
! @classlink RemTrans remote_remtrans.html
!*/
Object LoggConfig $ClassDef 27
Body SysBody
Attr Editor = pwr_eEditor_AttrEd
......@@ -48,14 +105,17 @@ SObject Remote:Class
Body SysBody
Attr StructName = "LoggConfig"
EndBody
!
! Parameter Description
!
!/**
! Name of log file, eg $pwrp_log/remote.log
!*/
Object LoggFile $Attribute 1
Body SysBody
Attr TypeRef = "pwrs:Type-$String40"
EndBody
EndObject
!/**
! Obsolete.
!*/
Object NewVersion $Attribute 2
Body SysBody
Attr TypeRef = "pwrs:Type-$Boolean"
......@@ -63,11 +123,21 @@ SObject Remote:Class
Attr Flags |= PWR_MASK_STATE
EndBody
EndObject
!/**
! Identity is used to direct the logging to a specific
! LoggConfig object. The first word in the log message should
! correspond to this value.
!
! Identity 90 is used for remote logging.
!*/
Object Identity $Attribute 3
Body SysBody
Attr TypeRef = "pwrs:Type-$UInt32"
EndBody
EndObject
!/**
! Number of loggings written to file since startup.
!*/
Object LoggCount $Attribute 4
Body SysBody
Attr TypeRef = "pwrs:Type-$UInt32"
......@@ -75,6 +145,9 @@ SObject Remote:Class
Attr Flags |= PWR_MASK_STATE
EndBody
EndObject
!/**
! Obsolete.
!*/
Object FileOpenCount $Attribute 5
Body SysBody
Attr TypeRef = "pwrs:Type-$UInt32"
......
remote/wbl/remote/src/remote_c_remnode3964r.wb_load
View file @ 3a72aa92
......@@ -46,8 +46,8 @@ SObject Remote:Class
! @image orm_remnode3964r_og.gif
!
! @b See also
! @classlink RemoteConfig pwrp_remoteconfig.html
! @classlink RemTrans ssab_remtrans.html
! @classlink RemoteConfig remote_remoteconfig.html
! @classlink RemTrans remote_remtrans.html
!*/
Object Remnode3964R $ClassDef 1
Body SysBody
......
remote/wbl/remote/src/remote_c_remnodealcm.wb_load
View file @ 3a72aa92
......@@ -52,8 +52,8 @@ SObject Remote:Class
! @image orm_remnodealcm_og.gif
!
! @b See also
! @classlink RemoteConfig pwrp_remoteconfig.html
! @classlink RemTrans ssab_remtrans.html
! @classlink RemoteConfig remote_remoteconfig.html
! @classlink RemTrans remote_remtrans.html
!*/
Object RemnodeALCM $ClassDef 2
Body SysBody
......
remote/wbl/remote/src/remote_c_remnodemodbus.wb_load
View file @ 3a72aa92
......@@ -46,8 +46,8 @@ SObject Remote:Class
! @image orm_remnodemodbus_og.gif
!
! @b See also
! @classlink RemoteConfig pwrp_remoteconfig.html
! @classlink RemTrans ssab_remtrans.html
! @classlink RemoteConfig remote_remoteconfig.html
! @classlink RemTrans remote_remtrans.html
!*/
Object RemnodeModbus $ClassDef 3
Body SysBody
......
remote/wbl/remote/src/remote_c_remnodemq.wb_load
View file @ 3a72aa92
......@@ -46,8 +46,8 @@ SObject Remote:Class
! @image orm_remnodemq_og.gif
!
! @b See also
! @classlink RemoteConfig pwrp_remoteconfig.html
! @classlink RemTrans ssab_remtrans.html
! @classlink RemoteConfig remote_remoteconfig.html
! @classlink RemTrans remote_remtrans.html
!*/
Object RemnodeMQ $ClassDef 4
Body SysBody
......
remote/wbl/remote/src/remote_c_remnoderk512.wb_load
View file @ 3a72aa92
......@@ -46,8 +46,8 @@ SObject Remote:Class
! @image orm_remnoderk512_og.gif
!
! @b See also
! @classlink RemoteConfig pwrp_remoteconfig.html
! @classlink RemTrans ssab_remtrans.html
! @classlink RemoteConfig remote_remoteconfig.html
! @classlink RemTrans remote_remtrans.html
!*/
Object RemnodeRK512 $ClassDef 9
Body SysBody
......
remote/wbl/remote/src/remote_c_remnodeserial.wb_load
View file @ 3a72aa92
......@@ -46,8 +46,8 @@ SObject Remote:Class
! @image orm_remnodeserial_og.gif
!
! @b See also
! @classlink RemoteConfig pwrp_remoteconfig.html
! @classlink RemTrans ssab_remtrans.html
! @classlink RemoteConfig remote_remoteconfig.html
! @classlink RemTrans remote_remtrans.html
!*/
Object RemnodeSerial $ClassDef 6
Body SysBody
......
remote/wbl/remote/src/remote_c_remnodetcp.wb_load
View file @ 3a72aa92
......@@ -46,8 +46,8 @@ SObject Remote:Class
! @image orm_remnodetcp_og.gif
!
! @b See also
! @classlink RemoteConfig pwrp_remoteconfig.html
! @classlink RemTrans ssab_remtrans.html
! @classlink RemoteConfig remote_remoteconfig.html
! @classlink RemTrans remote_remtrans.html
!*/
Object RemnodeTCP $ClassDef 8
Body SysBody
......
remote/wbl/remote/src/remote_c_remnodeudp.wb_load
View file @ 3a72aa92
......@@ -46,8 +46,8 @@ SObject Remote:Class
! @image orm_remnodeudp_og.gif
!
! @b See also
! @classlink RemoteConfig pwrp_remoteconfig.html
! @classlink RemTrans ssab_remtrans.html
! @classlink RemoteConfig remote_remoteconfig.html
! @classlink RemTrans remote_remtrans.html
!*/
Object RemnodeUDP $ClassDef 5
Body SysBody
......
remote/wbl/remote/src/remote_c_remnodewmq.wb_load
View file @ 3a72aa92
......@@ -54,8 +54,8 @@ SObject Remote:Class
! @image orm_remnodewmq_og.gif
!
! @b See also
! @classlink RemoteConfig pwrp_remoteconfig.html
! @classlink RemTrans ssab_remtrans.html
! @classlink RemoteConfig remote_remoteconfig.html
! @classlink RemTrans remote_remtrans.html
!*/
Object RemnodeWMQ $ClassDef 33
Body SysBody
......
remote/wbl/remote/src/remote_c_remtrans.wb_load
View file @ 3a72aa92
......@@ -36,9 +36,46 @@
! remote_c_RemTrans.wb_load -- Defines the class RemTrans.
!
SObject Remote:Class
!
! RemTrans - Remote Trans descripton
!
!/**
! @Version 1.0
! @Group Servers,NodeConfiguration
! @Summary Configures a remote message.
! Configures a remote message.
!
! The object describes a data message to or from another system. We can
! communicate with other Proview systems or with foreign systems in
! different ways, according to Transport type.
!
! The RemTrans object must be hierarchically placed directly under the
! RemNode object. The message data is fetched from, or stored into an object
! that is the only child of the RemTrans object.
!
! For certain messages, you can allow a limited number of buffered messages,
! both for sending and receiving.Buffered sending is used when we don't have
! connection to the remote node. Buffered receive is used if the final user of
! data is not fast enough to treat several incoming messages.
!
! For certain transports you can use built in acknowledgement for messages.
! Generic class that defines a specific message to or from a specific
! remote node on a specific protocol. Should be placed below the
! RemNode-object. The size of a message to be sent is specified in the
! RemTrans-object. The data to be sent however resides in a buffer that
! is configured as a child to the remtrans-object. When a message is to
! be sent, data of the length specified in the remtrans-object is fetched
! from the buffer. Sometimes however a header of some length is added to
! the message.
!
! @b See also
! @classlink RemoteConfig remote_remoteconfig.html
! @classlink RemnodeALCM remote_remnodealcm.html
! @classlink RemnodeModbus remote_remnodemodbus.html
! @classlink RemnodeMQ remote_remnodemq.html
! @classlink RemnodeRK512 remote_remnoderk512.html
! @classlink RemnodeSerial remote_remnodeserial.html
! @classlink RemnodeTCP remote_remnodetcp.html
! @classlink RemnodeUDB remote_remnodeudp.html
! @classlink RemnodeWMQ remote_remnodewmq.html
!*/
Object RemTrans $ClassDef 25
Body SysBody
Attr Editor = pwr_eEditor_AttrEd
......@@ -51,30 +88,86 @@ SObject Remote:Class
Body SysBody
Attr StructName = "RemTrans"
EndBody
!
! Parameter Description
!
!/**
! Optional description.
!*/
Object Description $Attribute 1
Body SysBody
Attr TypeRef = "pwrs:Type-$String80"
EndBody
EndObject
!
! Parameter TransName May be used for trans-identification
! VNET Taskname 6 letters
! ALCM Taskname 6 letters
! PAMS Not used
!
!/**
! For most transports this is only documentation.
! For ALCM sending messages you must store receiving task
! name (6 characters) here.
! For ALCM receive you store message id (6 characters) here.
!*/
Object TransName $Attribute 2
Body SysBody
Attr TypeRef = "pwrs:Type-$String40"
EndBody
EndObject
!
! Parameter Address May be used for trans-identification
! PAMS: Class, Type, ProccessNr.
! ALCM, VNET TransName is translated into this parameter
!
!/**
! @Summary Message address. Used different for different transports.
! Message address. Used different for different transports.
!
! ALCM
! Not used
!
! PAMS
! [0] - Class (0 - 255)
! [1] - Type (0 - 255)
! [2] - Processnumber for receiver (Only if we are sending)
!
! DMQ
! [0] - Class (0 - 255)
! [1] - Type (0 - 255)
! [2] - Processnumber for receiver (Only if we are sending)
! [3] - Used in DMQ to control delivery mode for outgoing
! messages:
! 0 Use delivery modes WF_DQF and SAF
! 1 Use delivery modes NN_MEM and DISC
! 2 Use delivery modes WF_DQF and DISC
! The WF_DQF delivery mode delivers the message to the remote
! recovery journal and blocks for verification or timeout.
! The NN_MEM delivery mode delivers the message to the
! destination queue and doesn\u2019t wait for any verification at all.
! The SAF function puts the message in the local recovery journal
! if the link is down. When using SAF, DMQ handles the
! retransmission meaning that we (Proview) can forget the
! message and treat it as sent. This works on DMQ 3.2 but is not
! supported in the earlier version 3.0.
! The DISC function tells DMQ to discard the message if it isn\u2019t
! deliverable. Can be used with WF_DQF along with the remote
! buffering mechanism.
! For a deeper description of delivery modes, consult the DMQ
! documentation.
! 3964R - VNET
! [0] - First 3 letters of Trans name / Task name in RAD50
! [1] - Next 3 letters of Trans name / Task name in RAD50
!
! 3964R
! Not used.
!
! RK512
! [0] - Address High byte (0 - 255)
! [1] - Address Low byte (0 - 255)
!
! TCP/ip and UDP/ip
! [0] - Message address part 1 ( 0 - 65535)
! [1] - Message address part 2 ( 0 - 65535)
!
! MODBUS
! [0] - Slave address
! [1] - Function code
!
! Serial
! [0] - Ascii number (decimal) for termination character #1
! [1] - Ascii number (decimal) for termination character #2
! [2] - Ascii number (decimal) for termination character #3
! [3] - Used to set the use of 7 or 8 bit character length. Set a value
! of 1 to use 7 bits and a value of 0 to use 8 bits.
!*/
Object Address $Attribute 3
Body SysBody
Attr TypeRef = "pwrs:Type-$UInt16"
......@@ -82,130 +175,185 @@ SObject Remote:Class
Attr Elements = 4
EndBody
EndObject
!
! Parameter Direction. (IN = 1, OUT = 2)
!
!/**
! Direction. Receive (1) or Send (2).
!*/
Object Direction $Attribute 4
Body SysBody
Attr TypeRef = "Remote:Type-TransDirectionEnum"
EndBody
EndObject
!
! Parameter DataLength
!
!/**
! Number of Bytes in message data. For outgoing messages this
! parameter must be set, either statically in the development
! system or dynamically via an application, before sending the
! message. For incoming messages this parameter is set by the
! transport when each message is received and shows the received
! length of this message.
!*/
Object DataLength $Attribute 5
Body SysBody
Attr TypeRef = "pwrs:Type-$UInt32"
EndBody
EndObject
!
! Parameter LoggLevel
!
!/**
! Each message can be logged to file by specifying a LoggLevel.
! 0: No logging.
! 1: Logging of time, message lenght and status when an error
! has occured.
! 2: Logging of time, message lenght and status for every message.
! 3: Logging of time, length, status and the first 48 bytes
! in hexadecimal code.
! 4: Logging of time, length, status and the whole message
! in hex code.
!
! The log-file is configured with a LoggConfig object with
! Identity set to 90.
!*/
Object LoggLevel $Attribute 6
Body SysBody
Attr TypeRef = "pwrs:Type-$UInt32"
EndBody
EndObject
!
! Parameter Maxbuffers (0 = no buffering)
!
!/**
! If MaxBuffers is > 0, send messages will be stored if the connection
! is down, and resent when the connection is up again.
!
! MaxBuffers is the maximum number of stored messages.
!
! In Remote UDP, when the message is outgoing, a value > 0 indicates
! that the message should be sent with wanted acknowledge.
!*/
Object MaxBuffers $Attribute 7
Body SysBody
Attr TypeRef = "pwrs:Type-$UInt32"
EndBody
EndObject
!
! Parameter Buffers Number of used buffers
!
!/**
! Current number or stored messages.
! For incoming messages this indicates the number of messages waiting
! to be taken by the PLC-process. For outgoing messages it tells the
! number of buffered messages waiting to be acked.
!*/
Object Buffers $Attribute 8
Body SysBody
Attr TypeRef = "pwrs:Type-$UInt32"
Attr Flags |= PWR_MASK_NOEDIT
EndBody
EndObject
!
! Parameter MaxLength Length of data-object
!
!/**
! Size of data receiving object, or data sending object.
! RemTrans can't handle messages bigger than this. Messages
! exceeding this size will be discarded.
! The attribute is updated by the transport and should be left
! blank in configuring.
!*/
Object MaxLength $Attribute 9
Body SysBody
Attr TypeRef = "pwrs:Type-$UInt32"
Attr Flags |= PWR_MASK_NOEDIT
EndBody
EndObject
!
! Parameter LastSts. (Returkod)
!
!/**
! Status of last transaction.
!
! 1: Success.
! 3: Receive data has been buffered.
! 0: Send failure.
! 2: Data length exceeds buffer object size.
! 4: Receive data has been lost.
! 6: Waiting for acknowledgement on message with auto ack.
!*/
Object LastSts $Attribute 10
Body SysBody
Attr TypeRef = "pwrs:Type-$UInt32"
Attr Flags |= PWR_MASK_NOEDIT
EndBody
EndObject
!
! Parameter TransTime Date and time for send / receive
!
!/**
! Transaction time for last received or sent/buffered message.
!*/
Object TransTime $Attribute 11
Body SysBody
Attr TypeRef = "pwrs:Type-$Time"
Attr Flags |= PWR_MASK_NOEDIT
EndBody
EndObject
!
! Parameter TransCount
!
!/**
! Number of successful transactions since start or restart.
!*/
Object TransCount $Attribute 12
Body SysBody
Attr TypeRef = "pwrs:Type-$UInt32"
Attr Flags |= PWR_MASK_NOEDIT
EndBody
EndObject
!
! Parameter BuffCount Number of buffered transactions
!
!/**
! Number of messages sent/received through buffering since start
! or restart.
!*/
Object BuffCount $Attribute 13
Body SysBody
Attr TypeRef = "pwrs:Type-$UInt32"
Attr Flags |= PWR_MASK_NOEDIT
EndBody
EndObject
!
! Parameter LostCount Received but not treated
!
!/**
! Number of received messages that were lost because they
! couldn't be buffered.
!*/
Object LostCount $Attribute 14
Body SysBody
Attr TypeRef = "pwrs:Type-$UInt32"
Attr Flags |= PWR_MASK_NOEDIT
EndBody
EndObject
!
! Parameter ErrCount Couldn't send
!
!/**
! Number of send failures.
!*/
Object ErrCount $Attribute 15
Body SysBody
Attr TypeRef = "pwrs:Type-$UInt32"
Attr Flags |= PWR_MASK_NOEDIT
EndBody
EndObject
!
! Parameter DataValid
!
!/**
! Flag for new data in data-object.
!
! When we receive a new message, it is stored into the data-object.
! Then the DataValid is set. The next message can not be stored
! before the final user has treated this message, and then reset the
! DataValid signal. When using RemTransRcv in the PLCprogram,
! this is handled automatically.
!
! When the original sender want to send a new message, he fills in
! the data, and then sets DataValid. The Remote transport will
! search for DataValid set, and send the message and then Reset
! the DataValid. Next message shouldn't be filled into the data
! object before the DataValid is reset. When using RemTransSend
! in the PLC-program, this is handled automatically.
!*/
Object DataValid $Attribute 16
Body SysBody
Attr TypeRef = "pwrs:Type-$Boolean"
Attr Flags |= PWR_MASK_NOEDIT
EndBody
EndObject
!
! Parameter StructName
!
!/**
! C struct name for the message.
! When a StructName and StructFile is supplied, the content of
! buffer object can be interpreted and displayed in accordance with
! this struct from System/Communication/RemTrans in rt_xtt.
!*/
Object StructName $Attribute 17
Body SysBody
Attr TypeRef = "pwrs:Type-$String40"
EndBody
EndObject
!
! Parameter StructFile
!
!/**
! C include file that contains the struct specified in StructName.
! Default directory is $pwrp_inc.
!*/
Object StructFile $Attribute 18
Body SysBody
Attr TypeRef = "pwrs:Type-$String80"
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment
GitLab Nexedi Edition | About GitLab | About Nexedi | 沪ICP备2021021310号-2 | 沪ICP备2021021310号-7