Skip to content

Commit 0e95177

Browse files
committed
documentation update
1 parent 7310213 commit 0e95177

File tree

99 files changed

+4714
-588
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

99 files changed

+4714
-588
lines changed

docs/README.html

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -90,12 +90,9 @@ <h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5>
9090
<h1 id="about-this-repository">About this Repository</h1>
9191

9292
<h2 id="pre-requisites">Pre-requisites</h2>
93-
<ul>
94-
<li>APAX 3.1.1</li>
95-
<li>AXCODE</li>
96-
<li>DOTNET 7.0.8.0</li>
97-
<li>VSCODE or VS2022</li>
98-
</ul>
93+
<p>Run following script to check the pre-requisites:</p>
94+
<pre><code>./scripts/check_requisites.ps1
95+
</code></pre>
9996
<h3 id="add-package-source">Add package source</h3>
10097
<p>To get access to the packages from <code>AX#</code> and <code>AXOpen</code> you will need to authenticate to a dedicated package feed hosted on GitHub. Authentication is free. If you do not have a GitHub account please consider creating one by signing up at <a href="https://github.com">https://github.com</a>.</p>
10198
<pre><code>dotnet nuget add source --username GITHUBUSERNAME --password PAT --store-password-in-clear-text --name gh-packages-inxton &quot;https://nuget.pkg.github.com/inxton/index.json&quot;

docs/components.abb.robotics/docs/ComponentTemplate.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ <h2 id="declare-component">Declare component</h2>
114114
manualControl : BOOL;
115115
END_VAR
116116
</code></pre><h2 id="initialize--run">Initialize &amp; Run</h2>
117-
<pre><code class="lang-pascal">AxoIrc5_v_1_x_x.Run( parent := THIS,
117+
<pre><code class="lang-pascal">AxoIrc5_v_1_x_x.Run(parent := parent,
118118
hwID := HwIdentifiers#RobotBasicIO_HwID,
119119
hwIdDI_64_bytes := HwIdentifiers#RobotBasicIO_DI_64_bytes_DI_64_bytes_HwID,
120120
hwIdDO_64_bytes := HwIdentifiers#RobotBasicIO_DO_64_bytes_DO_64_bytes_HwID);
@@ -130,7 +130,7 @@ <h2 id="use">Use</h2>
130130

131131
METHOD PRIVATE UseInSequencer
132132

133-
Sequencer.Initialize(THIS);
133+
Sequencer.Run(THIS);
134134
Sequencer.Open();
135135

136136
IF(Steps[0].Execute(Sequencer, 'Start at main')) THEN

docs/components.abb.robotics/docs/Component_1.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ <h2 id="declare-component">Declare component</h2>
113113
manualControl : BOOL;
114114
END_VAR
115115
</code></pre><h2 id="initialize--run">Initialize &amp; Run</h2>
116-
<pre><code class="lang-pascal">AxoIrc5_v_1_x_x.Run( parent := THIS,
116+
<pre><code class="lang-pascal">AxoIrc5_v_1_x_x.Run(parent := parent,
117117
hwID := HwIdentifiers#RobotBasicIO_HwID,
118118
hwIdDI_64_bytes := HwIdentifiers#RobotBasicIO_DI_64_bytes_DI_64_bytes_HwID,
119119
hwIdDO_64_bytes := HwIdentifiers#RobotBasicIO_DO_64_bytes_DO_64_bytes_HwID);
@@ -129,7 +129,7 @@ <h2 id="use">Use</h2>
129129

130130
METHOD PRIVATE UseInSequencer
131131

132-
Sequencer.Initialize(THIS);
132+
Sequencer.Run(THIS);
133133
Sequencer.Open();
134134

135135
IF(Steps[0].Execute(Sequencer, 'Start at main')) THEN

docs/components.abb.robotics/docs/Component_2.html

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -113,10 +113,10 @@ <h2 id="declare-component">Declare component</h2>
113113
manualControl : BOOL;
114114
END_VAR
115115
</code></pre><h2 id="initialize--run">Initialize &amp; Run</h2>
116-
<pre><code class="lang-pascal">AxoOmnicore_v_1_x_x.Run( parent := THIS,
117-
hwID := HwIdentifiers#OmniCore_HwID,
118-
hwIdDI_64_bytes := HwIdentifiers#OmniCore_DI_64_bytes_DI_64_bytes_HwID,
119-
hwIdDO_64_bytes := HwIdentifiers#OmniCore_DO_64_bytes_DO_64_bytes_HwID);
116+
<pre><code class="lang-pascal">AxoOmnicore_v_1_x_x.Run(parent := parent,
117+
hwID := HwIdentifiers#OmniCore_HwID,
118+
hwIdDI_64_bytes := HwIdentifiers#OmniCore_DI_64_bytes_DI_64_bytes_HwID,
119+
hwIdDO_64_bytes := HwIdentifiers#OmniCore_DO_64_bytes_DO_64_bytes_HwID);
120120
</code></pre><div class="IMPORTANT">
121121
<h5>Important</h5>
122122
<p>This component requires cyclic data updates, which are typically sourced from the I/O system. Before using the component, make sure you invoke the <code>Run</code> method. Additionally, it's crucial to ensure that the <code>Run</code> method is positioned within a call tree that operates cyclically. Failing to initiate the <code>Run</code> method or not guaranteeing its cyclic execution can lead to malfunctions and unpredictable component behavior. In extreme circumstances, this could cause erratic controller behavior, potentially leading to equipment damage.</p>
@@ -129,7 +129,7 @@ <h2 id="use">Use</h2>
129129

130130
METHOD PRIVATE UseInSequencer
131131

132-
Sequencer.Initialize(THIS);
132+
Sequencer.Run(THIS);
133133
Sequencer.Open();
134134

135135
IF(Steps[0].Execute(Sequencer, 'Start at main')) THEN

docs/components.balluff.identification/docs/ComponentTemplate.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,7 @@ <h2 id="use">Use</h2>
129129

130130
METHOD PRIVATE UseInSequencer
131131

132-
Sequencer.Initialize(THIS);
132+
Sequencer.Run(THIS);
133133
Sequencer.Open();
134134

135135
IF(Steps[0].Execute(Sequencer, 'Read')) THEN

docs/components.balluff.identification/docs/Component_1.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ <h2 id="use">Use</h2>
128128

129129
METHOD PRIVATE UseInSequencer
130130

131-
Sequencer.Initialize(THIS);
131+
Sequencer.Run(THIS);
132132
Sequencer.Open();
133133

134134
IF(Steps[0].Execute(Sequencer, 'Read')) THEN

docs/components.balluff.identification/docs/Component_2.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ <h2 id="use">Use</h2>
128128

129129
METHOD PRIVATE UseInSequencer
130130

131-
Sequencer.Initialize(THIS);
131+
Sequencer.Run(THIS);
132132
Sequencer.Open();
133133

134134
IF(Steps[0].Execute(Sequencer, 'Read')) THEN

docs/components.cognex.vision/docs/ComponentTemplate.html

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -141,8 +141,11 @@ <h2 id="use">Use</h2>
141141
END_VAR
142142

143143
METHOD PRIVATE UseInSequencer
144+
IF Sequencer.GetContext().OpenCycleCount() = ULINT#0 THEN
145+
Sequencer.SequenceMode := eAxoSequenceMode#RunOnce;
146+
END_IF;
144147

145-
Sequencer.Initialize(THIS);
148+
Sequencer.Run(THIS);
146149
Sequencer.Open();
147150

148151
IF(Steps[0].Execute(Sequencer, 'Change job')) THEN

docs/components.cognex.vision/docs/Component_1.html

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -140,8 +140,11 @@ <h2 id="use">Use</h2>
140140
END_VAR
141141

142142
METHOD PRIVATE UseInSequencer
143+
IF Sequencer.GetContext().OpenCycleCount() = ULINT#0 THEN
144+
Sequencer.SequenceMode := eAxoSequenceMode#RunOnce;
145+
END_IF;
143146

144-
Sequencer.Initialize(THIS);
147+
Sequencer.Run(THIS);
145148
Sequencer.Open();
146149

147150
IF(Steps[0].Execute(Sequencer, 'Change job')) THEN

docs/components.cognex.vision/docs/Component_2.html

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -116,14 +116,14 @@ <h2 id="declare-component">Declare component</h2>
116116
<pre><code class="lang-pascal">Dataman_280.Run(parent := THIS,
117117
ResultDataSize := AXOpen.Components.Cognex.Vision.v_6_0_0_0.eAxoDataman_ResultDataSize#RESULT_DATA_128B,
118118
UserDataSize := AXOpen.Components.Cognex.Vision.v_6_0_0_0.eAxoDataman_UserDataSize#USER_DATA_128B,
119-
hwID := HwIdentifiers#reader_st1_HwID,
120-
hwIdAcquisitionControl := HwIdentifiers#reader_st1_Acquisition_Control_Acquisition_Control_HwID,
121-
hwIdAcquisitionStatus := HwIdentifiers#reader_st1_Acquisition_Status_Acquisition_Status_HwID,
122-
hwIdResultsControl := HwIdentifiers#reader_st1_Results_Control_Results_Control_HwID,
123-
hwIdResultsStatus := HwIdentifiers#reader_st1_Results_Status_Results_Status_HwID,
124-
hwIdSoftEventControl := HwIdentifiers#reader_st1_Soft_Event_Control_Soft_Event_Control_HwID,
125-
hwIdResultData := HwIdentifiers#reader_st1_Result_Data_128_bytes_Result_Data___128_bytes_HwID,
126-
hwIdUserData := HwIdentifiers#reader_st1_User_Data_128_bytes_User_Data___128_bytes_HwID);
119+
hwID := HwIdentifiers#dm_280_HwID,
120+
hwIdAcquisitionControl := HwIdentifiers#dm_280_Acquisition_Control_Acquisition_Control_HwID,
121+
hwIdAcquisitionStatus := HwIdentifiers#dm_280_Acquisition_Status_Acquisition_Status_HwID,
122+
hwIdResultsControl := HwIdentifiers#dm_280_Results_Control_Results_Control_HwID,
123+
hwIdResultsStatus := HwIdentifiers#dm_280_Results_Status_Results_Status_HwID,
124+
hwIdSoftEventControl := HwIdentifiers#dm_280_Soft_Event_Control_Soft_Event_Control_HwID,
125+
hwIdResultData := HwIdentifiers#dm_280_Result_Data_128_bytes_Result_Data___128_bytes_HwID,
126+
hwIdUserData := HwIdentifiers#dm_280_User_Data_128_bytes_User_Data___128_bytes_HwID);
127127
</code></pre><div class="IMPORTANT">
128128
<h5>Important</h5>
129129
<p>This component requires cyclic data updates, which are typically sourced from the I/O system. Before using the component, make sure you invoke the <code>Run</code> method. Additionally, it's crucial to ensure that the <code>Run</code> method is positioned within a call tree that operates cyclically. Failing to initiate the <code>Run</code> method or not guaranteeing its cyclic execution can lead to malfunctions and unpredictable component behavior. In extreme circumstances, this could cause erratic controller behavior, potentially leading to equipment damage.</p>
@@ -139,8 +139,11 @@ <h2 id="use">Use</h2>
139139
END_VAR
140140

141141
METHOD PRIVATE UseInSequencer
142+
IF Sequencer.GetContext().OpenCycleCount() = ULINT#0 THEN
143+
Sequencer.SequenceMode := eAxoSequenceMode#RunOnce;
144+
END_IF;
142145

143-
Sequencer.Initialize(THIS);
146+
Sequencer.Run(THIS);
144147
Sequencer.Open();
145148

146149

@@ -150,15 +153,15 @@ <h2 id="use">Use</h2>
150153
END_IF;
151154
END_IF;
152155

153-
IF(Steps[1].Execute(Sequencer, 'Change job')) THEN
156+
IF(Steps[1].Execute(Sequencer, 'Read data')) THEN
154157
IF(Dataman_280.Read().IsDone()) THEN
155158
Sequencer.MoveNext();
156159
END_IF;
157160
END_IF;
158161

159162
IF(Steps[2].Execute(Sequencer, 'Evaluate data')) THEN
160163
_ResultData := Dataman_280.ResultData;
161-
Sequencer.MoveNext();
164+
Sequencer.CompleteSequence();
162165
END_IF;
163166

164167

0 commit comments

Comments
 (0)