Commit a3d469bf authored by Claes's avatar Claes Committed by Esteban Blanc

Doc for redundancy added and some mpc doc change

parent 2c49498a
...@@ -39,8 +39,21 @@ SObject pwrb:Class ...@@ -39,8 +39,21 @@ SObject pwrb:Class
!/** !/**
! @Version 1.0 ! @Version 1.0
! @Group Servers,NodeConfiguration ! @Group Servers,NodeConfiguration
! @Summary Configuration of redundance communication. ! @Summary Configuration of the redundancy server.
! Configuration of redundancy communication. ! Configuration of the redundancy server.
!
! The redundancy server, rt_redcom, handles the redundancy
! communication between active and passive node. It also handles
! the failover supervision.
!
! Transfer of object data is handled by plc threads and
! configured with RedcomPacket objects.
!
! @image orm_redcomconfig_1.png
! Fig Redundancy communication
!
! @b Se also
! @classlink RedcomPacket pwrb_redcompacket.html
!*/ !*/
Object RedcomConfig $ClassDef 686 Object RedcomConfig $ClassDef 686
Body SysBody Body SysBody
...@@ -61,6 +74,7 @@ SObject pwrb:Class ...@@ -61,6 +74,7 @@ SObject pwrb:Class
EndObject EndObject
!/** !/**
! Cycle time. ! Cycle time.
! The cycle time should equal or be faster than the fastest plc thread.
!*/ !*/
Object CycleTime $Attribute 2 Object CycleTime $Attribute 2
Body SysBody Body SysBody
...@@ -78,8 +92,10 @@ SObject pwrb:Class ...@@ -78,8 +92,10 @@ SObject pwrb:Class
EndBody EndBody
EndObject EndObject
!/** !/**
! Startup timeout time. ! Delay time for the start of failover supervision.
! Increased timeout time at startup. ! For plc threads handling large amounts of data, the startup
! sequence with creating an attribute list and a table packet
! will take some time and the failover supervision has to be delayed.
!*/ !*/
Object StartupTimeout $Attribute 4 Object StartupTimeout $Attribute 4
Body SysBody Body SysBody
...@@ -88,9 +104,9 @@ SObject pwrb:Class ...@@ -88,9 +104,9 @@ SObject pwrb:Class
EndObject EndObject
!/** !/**
! Force state. ! Force state.
! State can only be changed from Active/Passive buttons in ! At force state the state can only be changed from Active/Passive
! object graph. It will not automatically be changed by system ! buttons in object graph. It will not automatically be changed by
! events or errors. ! system events or errors.
!*/ !*/
Object Force $Attribute 5 Object Force $Attribute 5
Body SysBody Body SysBody
...@@ -129,6 +145,21 @@ SObject pwrb:Class ...@@ -129,6 +145,21 @@ SObject pwrb:Class
EndObject EndObject
!/** !/**
! Failover reason. ! Failover reason.
! Reasons that are able to cause a failover.
!
! - EmergencyBreak. The EmergencyBreak attribute in the node object is set.
! The cause for this can be that some IO module doesn't respond, or time
! out from a plc thread.
!
! - SystemStatus. Error indication in system status is caused by timeout or
! error indication in any system process of application.
!
! - Communication timeout. If the packets from the active node hasn't arrived
! within the timeout time. The timeout time is configured in the
! RedcomConfig object.
!
! - Manuel transition. A transition can be initiated manually from for example
! the object graph for the RecomConfig object.
!*/ !*/
Object FailoverReason $Attribute 9 Object FailoverReason $Attribute 9
Body SysBody Body SysBody
...@@ -136,7 +167,8 @@ SObject pwrb:Class ...@@ -136,7 +167,8 @@ SObject pwrb:Class
EndBody EndBody
EndObject EndObject
!/** !/**
! Link state. ! Link state array.
! The first element contains info about the link to the secondary node.
!*/ !*/
Object Link $Attribute 10 Object Link $Attribute 10
Body SysBody Body SysBody
......
...@@ -41,6 +41,17 @@ SObject pwrb:Class ...@@ -41,6 +41,17 @@ SObject pwrb:Class
! @Group Servers,NodeConfiguration ! @Group Servers,NodeConfiguration
! @Summary Configuration of redundancy packet. ! @Summary Configuration of redundancy packet.
! Configuration of redundancy packet. ! Configuration of redundancy packet.
! Redundancy packets are sent from plc threads in the active node
! to the corresponding threads in the passive node. They contain
! values from objects in the database that are handled by the thread.
!
! The RedcomPacket object is placed under the PlcThread object.
!
! Also applications can send redundancy packets.
!
! @b Se also
! @classlink RedcomConfig pwrb_redcomconfig.html
! @classlink PlcThread pwrb_plcthread.html
!*/ !*/
Object RedcomPacket $ClassDef 688 Object RedcomPacket $ClassDef 688
Body SysBody Body SysBody
...@@ -60,7 +71,7 @@ SObject pwrb:Class ...@@ -60,7 +71,7 @@ SObject pwrb:Class
EndBody EndBody
EndObject EndObject
!/** !/**
! Priority. ! Packet priority in the interval 0 to 10 where 10 is the highest priority.
!*/ !*/
Object Prio $Attribute 2 Object Prio $Attribute 2
Body SysBody Body SysBody
...@@ -78,7 +89,8 @@ SObject pwrb:Class ...@@ -78,7 +89,8 @@ SObject pwrb:Class
EndBody EndBody
EndObject EndObject
!/** !/**
! Transmit packet count. ! Transmit count.
! Number of transmitted packets.
!*/ !*/
Object TransmitCnt $Attribute 4 Object TransmitCnt $Attribute 4
Body SysBody Body SysBody
...@@ -88,7 +100,8 @@ SObject pwrb:Class ...@@ -88,7 +100,8 @@ SObject pwrb:Class
EndBody EndBody
EndObject EndObject
!/** !/**
! Receive acket count. ! Receive count.
! Number of received packets.
!*/ !*/
Object ReceiveCnt $Attribute 5 Object ReceiveCnt $Attribute 5
Body SysBody Body SysBody
...@@ -118,7 +131,8 @@ SObject pwrb:Class ...@@ -118,7 +131,8 @@ SObject pwrb:Class
EndBody EndBody
EndObject EndObject
!/** !/**
! Table status. ! Table packet status.
! Status for the last sending or receiving of table packet.
!*/ !*/
Object TableStatus $Attribute 12 Object TableStatus $Attribute 12
Body SysBody Body SysBody
...@@ -128,7 +142,7 @@ SObject pwrb:Class ...@@ -128,7 +142,7 @@ SObject pwrb:Class
EndBody EndBody
EndObject EndObject
!/** !/**
! Table status. ! Table version.
!*/ !*/
Object TableVersion $Attribute 13 Object TableVersion $Attribute 13
Body SysBody Body SysBody
...@@ -168,7 +182,8 @@ SObject pwrb:Class ...@@ -168,7 +182,8 @@ SObject pwrb:Class
EndBody EndBody
EndObject EndObject
!/** !/**
! Coverage. ! Relation between the time for creating and sending of the
! packet and the scan time for the thread. Value in percentage.
!*/ !*/
Object Coverage $Attribute 11 Object Coverage $Attribute 11
Body SysBody Body SysBody
......
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