Gocator API
 All Classes Files Functions Variables Typedefs Macros Modules Pages
GoEthernet.h
Go to the documentation of this file.
1 /**
2  * @file GoEthernet.h
3  * @brief Declares the GoEthernet class.
4  *
5  * @internal
6  * Copyright (C) 2016-2021 by LMI Technologies Inc.
7  * Licensed under the MIT License.
8  * Redistributed files must retain the above copyright notice.
9  */
10 #ifndef GO_SDK_ETHERNET_H
11 #define GO_SDK_ETHERNET_H
12 
13 #include <GoSdk/GoSdkDef.h>
14 
15 /**
16  * @class GoEthernet
17  * @extends kObject
18  * @ingroup GoSdk-Ethernet
19  * @brief Represents Ethernet output settings.
20  */
21 typedef kObject GoEthernet;
22 
23 /**
24  * Indicates whether the ethernet connection timeout is enabled. If it is
25  * enabled, the configured timeout value will be used.
26  *
27  * @public @memberof GoEthernet
28  * @version Introduced in firmware 4.3.3.124
29  * @param ethernet GoEthernet object.
30  * @return kTRUE if enabled and kFALSE otherwise.
31  * @see GoEthernet_Timeout, GoEthernet_SetTimeout
32  */
34 
35 /**
36  * Enables or disables the ethernet connection timeout.
37  *
38  * @public @memberof GoEthernet
39  * @version Introduced in firmware 4.3.3.124
40  * @param ethernet GoEthernet object.
41  * @param value kTRUE to enable the connection timeout and
42  * kFALSE to disable it.
43  * @return Operation status.
44  */
45 GoFx(kStatus) GoEthernet_EnableTimeout(GoEthernet ethernet, kBool value);
46 
47 /**
48 * Indicates whether ethernet connection timeout is supported or not by
49 * the ethernet protocol. If connection timeout is not supported, then
50 * enabling/disabling the connection timeout and the timeout value are
51 * not meaningful.
52 *
53 * @public @memberof GoEthernet
54 * @version Introduced in firmware 4.7.11.27.
55 * @param ethernet GoEthernet object.
56 * @return True means the ethernet protocol supports connection
57 * timeout.
58 * False means otherwise.
59 */
61 
62 /**
63  * Returns the connection timeout value in minutes.
64  *
65  * @public @memberof GoEthernet
66  * @version Introduced in firmware 4.3.3.124
67  * @param ethernet GoEthernet object.
68  * @return Connection timeout value in minutes.
69  */
70 GoFx(k64f) GoEthernet_Timeout(GoEthernet ethernet);
71 
72 /**
73  * Sets the connection timeout value.
74  *
75  * @public @memberof GoEthernet
76  * @version Introduced in firmware 4.3.3.124
77  * @param ethernet GoEthernet object.
78  * @param value The timeout value (in minutes).
79  * @return Operation status.
80  */
81 GoFx(kStatus) GoEthernet_SetTimeout(GoEthernet ethernet, k64f value);
82 
83 /**
84  * Gets the number of source options for the specified output type.
85  *
86  * @public @memberof GoEthernet
87  * @version Introduced in firmware 4.0.10.27
88  * @param ethernet GoEthernet object.
89  * @param type Output source type.
90  * @return Count of source options.
91  */
93 
94 /**
95  * Gets the source option at the specified index.
96  *
97  * @public @memberof GoEthernet
98  * @version Introduced in firmware 4.0.10.27
99  * @param ethernet GoEthernet object.
100  * @param type Output source type.
101  * @param index Source option index.
102  * @return Source option.
103  */
104 GoFx(k32u) GoEthernet_OptionAt(GoEthernet ethernet, GoOutputSource type, kSize index);
105 
106 /**
107  * Gets the number of sources of the specified output type that have been selected for transmission.
108  * The selected output source continues to be included in the count even if the source is no longer valid,
109  * such as by deleting the tool that generated the source.
110  * The count decrements only when an output source is unselected.
111  *
112  * @public @memberof GoEthernet
113  * @version Introduced in firmware 4.0.10.27
114  * @param ethernet GoEthernet object.
115  * @param type Output source type.
116  * @return Count of selected sources.
117  */
119 
120 /**
121  * Gets the identifier of the selected output at the specified index.
122  *
123  * @public @memberof GoEthernet
124  * @version Introduced in firmware 4.0.10.27
125  * @param ethernet GoEthernet object.
126  * @param type Output source type.
127  * @param index Selected source index.
128  * @return Source identifier.
129  */
130 GoFx(k32u) GoEthernet_SourceAt(GoEthernet ethernet, GoOutputSource type, kSize index);
131 
132 /**
133  * Selects the specified source for transmission.
134  *
135  * @public @memberof GoEthernet
136  * @version Introduced in firmware 4.0.10.27
137  * @param ethernet GoEthernet object.
138  * @param type Output source type.
139  * @param sourceId Output source identifier.
140  * @return Operation status.
141  */
142 GoFx(kStatus) GoEthernet_AddSource(GoEthernet ethernet, GoOutputSource type, k32s sourceId);
143 
144 /**
145  * Removes (deselects) the source at the specified index.
146  *
147  * @public @memberof GoEthernet
148  * @version Introduced in firmware 4.0.10.27
149  * @param ethernet GoEthernet object.
150  * @param type Output source type.
151  * @param index Index of the source to be removed.
152  * @return Operation status.
153  */
154 GoFx(kStatus) GoEthernet_RemoveSource(GoEthernet ethernet, GoOutputSource type, kSize index);
155 
156 /**
157  * Removes (deselects) all selected sources for the specified output type.
158  *
159  * @public @memberof GoEthernet
160  * @version Introduced in firmware 4.0.10.27
161  * @param ethernet GoEthernet object.
162  * @param type Output source type.
163  * @return Operation status.
164  */
166 
167 /**
168  * Removes (deselects) all selected sources for all possible ethernet output types.
169  *
170  * @public @memberof GoEthernet
171  * @version Introduced in firmware 4.0.10.27
172  * @param ethernet GoEthernet object.
173  * @return Operation status.
174  */
176 
177 
178 /**
179  * Gets the number of composite source options for the specified output type.
180  *
181  * @public @memberof GoEthernet
182  * @version Introduced in firmware 4.4.4.14
183 
184  * @param ethernet GoEthernet object.
185  * @param type Output data type.
186  * @return Count of composite source options.
187  */
189 
190 /**
191  * Gets the composite source option at the specified index.
192  *
193  * @public @memberof GoEthernet
194  * @version Introduced in firmware 4.4.4.14
195  * @param ethernet GoEthernet object.
196  * @param type Output source type.
197  * @param index List index.
198  * @return Composite source option.
199  */
201 
202 /**
203  * Gets the number of composite sources of the specified output type that are currently selected for transmission.
204  *
205  * @public @memberof GoEthernet
206  * @version Introduced in firmware 4.4.4.14
207  * @param ethernet GoEthernet object.
208  * @param type Output CompositeSource type.
209  * @return Count of selected composite data sources.
210  */
212 
213 /**
214  * Gets the identifier of the selected output at the specified index.
215  *
216  * @public @memberof GoEthernet
217  * @version Introduced in firmware 4.4.4.14
218  * @param ethernet GoEthernet object.
219  * @param type Output CompositeSource type.
220  * @param index Selected index.
221  * @return Composite source value.
222  */
224 
225 /**
226  * Selects the specified composite source for transmission.
227  *
228  * @public @memberof GoEthernet
229  * @version Introduced in firmware 4.4.4.14
230  * @param ethernet GoEthernet object.
231  * @param type Output CompositeSource type.
232  * @param source Composite source identifier.
233  * @return Operation status.
234  */
236 
237 /**
238  * Removes (deselects) the composite source at the specified index.
239  *
240  * @public @memberof GoEthernet
241  * @version Introduced in firmware 4.4.4.14
242  * @param ethernet GoEthernet object.
243  * @param type Output type.
244  * @param index Index of the composite source to be removed.
245  * @return Operation status.
246  */
248 
249 /**
250  * Gets the number of event options.
251  *
252  * @public @memberof GoEthernet
253  * @version Introduced in firmware 4.5.3.57
254  * @param ethernet GoEthernet object.
255  * @return Count of event options.
256  */
258 
259 /**
260  * Gets the event option at the specified index.
261  *
262  * @public @memberof GoEthernet
263  * @version Introduced in firmware 4.5.3.57
264  * @param ethernet GoEthernet object.
265  * @param index Event EventOption index.
266  * @return Event EventOption.
267  */
269 
270 /**
271  * Gets the number of events selected for Gocator protocol output.
272  *
273  * @public @memberof GoEthernet
274  * @version Introduced in firmware 4.5.3.57
275  * @param ethernet GoEthernet object.
276  * @return Count of selected Events.
277  */
278 GoFx(kSize) GoEthernet_EventCount(GoEthernet ethernet);
279 
280 /**
281  * Gets the output event associated with the specified index.
282  *
283  * @public @memberof GoEthernet
284  * @version Introduced in firmware 4.5.3.57
285  * @param ethernet GoEthernet object.
286  * @param index Selected event index.
287  * @return Event identifier.
288  */
289 GoFx(GoEventType) GoEthernet_EventAt(GoEthernet ethernet, kSize index);
290 
291 /**
292  * Selects the specified event for transmission.
293  *
294  * @public @memberof GoEthernet
295  * @version Introduced in firmware 4.5.3.57
296  * @param ethernet GoEthernet object.
297  * @param type The type of event to add/select.
298  * @return Operation status.
299  */
300 GoFx(kStatus) GoEthernet_AddEvent(GoEthernet ethernet, GoEventType type);
301 
302 /**
303  * Removes (deselects) the Event at the specified index.
304  *
305  * @public @memberof GoEthernet
306  * @version Introduced in firmware 4.5.3.57
307  * @param ethernet GoEthernet object.
308  * @param index Index of the event to be removed.
309  * @return Operation status.
310  */
311 GoFx(kStatus) GoEthernet_RemoveEvent(GoEthernet ethernet, kSize index);
312 
313 /**
314  * Removes (deselects) all selected events.
315  *
316  * @public @memberof GoEthernet
317  * @version Introduced in firmware 4.5.3.57
318  * @param ethernet GoEthernet object.
319  * @return Operation status.
320  */
322 
323 /**
324  * Gets the protocol that the ethernet utilizes for output.
325  *
326  * @public @memberof GoEthernet
327  * @version Introduced in firmware 4.0.10.27
328  * @param ethernet GoEthernet object.
329  * @return The ethernet protocol.
330  */
332 
333 /**
334  * Sets the protocol which will be output via ethernet.
335  *
336  * @public @memberof GoEthernet
337  * @version Introduced in firmware 4.0.10.27
338  * @param ethernet GoEthernet object.
339  * @param protocol The selected ethernet protocol.
340  * @return Operation status.
341  */
343 
344 /**
345  * Gets the ASCII protocol operational mode.
346  *
347  * @public @memberof GoEthernet
348  * @version Introduced in firmware 4.0.10.27
349  * @param ethernet GoEthernet object.
350  * @return Operation mode.
351  */
353 
354 /**
355  * Sets the ASCII operation mode.
356  *
357  * @public @memberof GoEthernet
358  * @version Introduced in firmware 4.0.10.27
359  * @param ethernet GoEthernet object.
360  * @param mode The selected ASCII operation mode.
361  * @return Operation status.
362  */
364 
365 /**
366  * Gets the ASCII protocol control channel port number.
367  *
368  * @public @memberof GoEthernet
369  * @version Introduced in firmware 4.0.10.27
370  * @param ethernet GoEthernet object.
371  * @return Control channel port number.
372  */
374 
375 /**
376  * Sets the port number of the ASCII control port.
377  *
378  * @public @memberof GoEthernet
379  * @version Introduced in firmware 4.0.10.27
380  * @param ethernet GoEthernet object.
381  * @param port The selected ASCII control port value.
382  * @return Operation status.
383  */
385 
386 /**
387  * Gets the ASCII protocol health channel port number.
388  *
389  * @public @memberof GoEthernet
390  * @version Introduced in firmware 4.0.10.27
391  * @param ethernet GoEthernet object.
392  * @return Health channel port number.
393  */
395 
396 /**
397  * Sets the port number of the ASCII health port.
398  *
399  * @public @memberof GoEthernet
400  * @version Introduced in firmware 4.0.10.27
401  * @param ethernet GoEthernet object.
402  * @param port The selected ASCII health port value.
403  * @return Operation status.
404  */
406 
407 /**
408  * Gets the ASCII protocol data channel port number.
409  *
410  * @public @memberof GoEthernet
411  * @version Introduced in firmware 4.0.10.27
412  * @param ethernet GoEthernet object.
413  * @return Data channel port number.
414  */
416 
417 /**
418  * Sets the port number of the ASCII data port.
419  *
420  * @public @memberof GoEthernet
421  * @version Introduced in firmware 4.0.10.27
422  * @param ethernet GoEthernet object.
423  * @param port The selected ASCII data port value.
424  * @return Operation status.
425  */
426 GoFx(kStatus) GoEthernet_SetAsciiDataPort(GoEthernet ethernet, k32u port);
427 
428 /**
429  * Gets the ASCII protocol output delimiter string.
430  *
431  * @public @memberof GoEthernet
432  * @version Introduced in firmware 4.0.10.27
433  * @param ethernet GoEthernet object.
434  * @return A pointer to the string representing the ASCII protocol output delimiter.
435  */
437 
438 /**
439  * Sets the ASCII protocol output delimiter string.
440  *
441  * @public @memberof GoEthernet
442  * @version Introduced in firmware 4.0.10.27
443  * @param ethernet GoEthernet object.
444  * @param string A pointer to the string representing the ASCII protocol output delimiter.
445  * @return Operation status.
446  */
447 GoFx(kStatus) GoEthernet_SetAsciiDelimiter(GoEthernet ethernet, const kChar* string);
448 
449 /**
450  * Gets the ASCII protocol output terminator string.
451  *
452  * @public @memberof GoEthernet
453  * @version Introduced in firmware 4.0.10.27
454  * @param ethernet GoEthernet object.
455  * @return A pointer to the terminator representing the ASCII protocol output delimiter.
456  */
458 
459 /**
460  * Sets the ASCII protocol output terminator string.
461  *
462  * @public @memberof GoEthernet
463  * @version Introduced in firmware 4.0.10.27
464  * @param ethernet GoEthernet object.
465  * @param string A pointer to the string representing the ASCII protocol output terminator.
466  * @return Operation status.
467  */
468 GoFx(kStatus) GoEthernet_SetAsciiTerminator(GoEthernet ethernet, const kChar* string);
469 
470 /**
471  * Gets the ASCII protocol output invalid value string.
472  *
473  * @public @memberof GoEthernet
474  * @version Introduced in firmware 4.0.10.27
475  * @param ethernet GoEthernet object.
476  * @return A pointer to the string representing the ASCII protocol output invalid value.
477  */
479 
480 /**
481  * Sets the ASCII protocol output invalid value string.
482  *
483  * @public @memberof GoEthernet
484  * @version Introduced in firmware 4.0.10.27
485  * @param ethernet GoEthernet object.
486  * @param string A pointer to the string representing the ASCII protocol output invalid value.
487  * @return Operation status.
488  */
489 GoFx(kStatus) GoEthernet_SetAsciiInvalidValue(GoEthernet ethernet, const kChar* string);
490 
491 /**
492  * Gets the ASCII protocol output custom data format string.
493  *
494  * @public @memberof GoEthernet
495  * @version Introduced in firmware 4.0.10.27
496  * @param ethernet GoEthernet object.
497  * @return A pointer to the string representing the ASCII protocol output custom data format.
498  */
500 
501 /**
502  * Sets the ASCII protocol output custom data format string.
503  *
504  * @public @memberof GoEthernet
505  * @version Introduced in firmware 4.0.10.27
506  * @param ethernet GoEthernet object.
507  * @param string A pointer to the string representing the ASCII protocol output custom data format (10,000 character limit).
508  * @return Operation status.
509  */
510 GoFx(kStatus) GoEthernet_SetAsciiCustomDataFormat(GoEthernet ethernet, const kChar* string);
511 
512 /**
513  * Enables or disables the ASCII protocol output custom data format.
514  *
515  * @public @memberof GoEthernet
516  * @version Introduced in firmware 4.0.10.27
517  * @param ethernet GoEthernet object.
518  * @param enabled kTRUE to enable custom data format output. kFALSE to use the default output format.
519  * @return Operation status.
520  */
522 
523 /**
524  * Returns the value of whether the ASCII protocol custom data format is enabled or disabled.
525  *
526  * @public @memberof GoEthernet
527  * @version Introduced in firmware 4.0.10.27
528  * @param ethernet GoEthernet object.
529  * @return kTRUE if the custom data format is enabled. kFALSE otherwise.
530  */
532 
533 /**
534  * Sets the current standard format mode.
535  *
536  * @public @memberof GoEthernet
537  * @version Introduced in firmware 4.5.3.57
538  * @param ethernet GoEthernet object.
539  * @param mode The new StandardFormatMode.
540  * @return Operation status.
541  */
543 
544 /**
545  * Gets the current standard format mode.
546  *
547  * @public @memberof GoEthernet
548  * @version Introduced in firmware 4.5.3.57
549  * @param ethernet GoEthernet object.
550  * @return The StandardFormatMode.
551  */
553 
554 /**
555  * Enables or disables EthernetIP protocol output buffering.
556  *
557  * @public @memberof GoEthernet
558  * @version Introduced in firmware 4.0.10.27
559  * @param ethernet GoEthernet object.
560  * @param enabled kTRUE to enable buffering. kFALSE to disable it.
561  * @return Operation status.
562  */
564 
565 /**
566  * Returns the value of whether the EthernetIP protocol output buffering is enabled or disabled.
567  *
568  * @public @memberof GoEthernet
569  * @version Introduced in firmware 4.0.10.27
570  * @param ethernet GoEthernet object.
571  * @return kTRUE if buffering is enabled. kFALSE otherwise.
572  */
574 
575 /**
576  * Sets the EthernetIP protocol endian output type.
577  *
578  * @public @memberof GoEthernet
579  * @version Introduced in firmware 4.1.3.106
580  * @param ethernet GoEthernet object.
581  * @param type The endian output type to set.
582  * @return Operation status.
583  */
585 
586 /**
587  * Returns the value of the EthernetIP protocol endian output type.
588  *
589  * @public @memberof GoEthernet
590  * @version Introduced in firmware 4.1.3.106
591  * @param ethernet GoEthernet object.
592  * @return Endian output type.
593  */
595 
596 /**
597  * Sets the EthernetIP protocol implicit trigger override.
598  *
599  * @public @memberof GoEthernet
600  * @version Introduced in firmware 4.2.4.7
601  * @param ethernet GoEthernet object.
602  * @param value The implicit trigger override value to set.
603  * @return Operation status.
604  */
606 
607 /**
608  * Returns the value of the EthernetIP protocol implicit trigger override.
609  *
610  * @public @memberof GoEthernet
611  * @version Introduced in firmware 4.2.4.7
612  * @param ethernet GoEthernet object.
613  * @return Implicit trigger override value.
614  */
616 
617 /**
618  * Enables or disables Modbus protocol output buffering.
619  *
620  * @public @memberof GoEthernet
621  * @version Introduced in firmware 4.0.10.27
622  * @param ethernet GoEthernet object.
623  * @param enabled kTRUE to enable buffering. kFALSE to disable it.
624  * @return Operation status.
625  */
627 
628 /**
629  * Returns the value of whether Modbus protocol output buffering is enabled or disabled.
630  *
631  * @public @memberof GoEthernet
632  * @version Introduced in firmware 4.0.10.27
633  * @param ethernet GoEthernet object.
634  * @return kTRUE if buffering is enabled. kFALSE otherwise.
635  */
637 
638 /**
639 * Returns the IP address of the Profinet protocol device.
640 *
641 * @public @memberof GoEthernet
642 * @version Introduced in firmware 5.2.18.3
643 * @param ethernet GoEthernet object.
644 * @return Pointer to Profinet device IP address.
645 */
646 GoFx(const kIpAddress*) GoEthernet_ProfinetIpAddress(GoEthernet ethernet);
647 
648 /**
649 * Returns the IP subnet mask of the Profinet protocol device.
650 *
651 * @public @memberof GoEthernet
652 * @version Introduced in firmware 5.2.18.3
653 * @param ethernet GoEthernet object.
654 * @return Pointer to Profinet device IP subnet mask.
655 */
657 
658 /**
659 * Returns the IP gateway address of the Profinet protocol device.
660 *
661 * @public @memberof GoEthernet
662 * @version Introduced in firmware 5.2.18.3
663 * @param ethernet GoEthernet object.
664 * @return Pointer to Profinet device IP gateway address.
665 */
666 GoFx(const kIpAddress*) GoEthernet_ProfinetGateway(GoEthernet ethernet);
667 
668 /**
669 * Returns the Profinet protocol device name.
670 *
671 * @public @memberof GoEthernet
672 * @version Introduced in firmware 5.2.18.3
673 * @param ethernet GoEthernet object.
674 * @return Pointer to the Profinet device name.
675 */
676 GoFx(const kChar*) GoEthernet_ProfinetDeviceName(GoEthernet ethernet);
677 
678 #include <GoSdk/Outputs/GoEthernet.x.h>
679 
680 #endif
kSize GoEthernet_EventCount(GoEthernet ethernet)
Gets the number of events selected for Gocator protocol output.
kStatus GoEthernet_SetAsciiStandardFormat(GoEthernet ethernet, GoAsciiStandardFormatMode mode)
Sets the current standard format mode.
GoOutputCompositeSource GoEthernet_CompositeOptionAt(GoEthernet ethernet, GoOutputSource type, kSize index)
Gets the composite source option at the specified index.
kStatus GoEthernet_ClearEvents(GoEthernet ethernet)
Removes (deselects) all selected events.
kSize GoEthernet_EventOptionCount(GoEthernet ethernet)
Gets the number of event options.
const kIpAddress * GoEthernet_ProfinetSubnetMask(GoEthernet ethernet)
Returns the IP subnet mask of the Profinet protocol device.
kStatus GoEthernet_ClearAllSources(GoEthernet ethernet)
Removes (deselects) all selected sources for all possible ethernet output types.
kStatus GoEthernet_SetEIPImplicitTriggerOverride(GoEthernet ethernet, GoImplicitTriggerOverride value)
Sets the EthernetIP protocol implicit trigger override.
kChar * GoEthernet_AsciiCustomDataFormat(GoEthernet ethernet)
Gets the ASCII protocol output custom data format string.
kBool GoEthernet_ModbusBufferingEnabled(GoEthernet ethernet)
Returns the value of whether Modbus protocol output buffering is enabled or disabled.
kStatus GoEthernet_AddCompositeSource(GoEthernet ethernet, GoOutputSource type, GoOutputCompositeSource source)
Selects the specified composite source for transmission.
kStatus GoEthernet_RemoveSource(GoEthernet ethernet, GoOutputSource type, kSize index)
Removes (deselects) the source at the specified index.
GoOutputCompositeSource GoEthernet_CompositeSourceAt(GoEthernet ethernet, GoOutputSource type, kSize index)
Gets the identifier of the selected output at the specified index.
k32u GoEthernet_AsciiDataPort(GoEthernet ethernet)
Gets the ASCII protocol data channel port number.
k32u GoEthernet_AsciiControlPort(GoEthernet ethernet)
Gets the ASCII protocol control channel port number.
kStatus GoEthernet_SetProtocol(GoEthernet ethernet, GoEthernetProtocol protocol)
Sets the protocol which will be output via ethernet.
kStatus GoEthernet_SetAsciiHealthPort(GoEthernet ethernet, k32u port)
Sets the port number of the ASCII health port.
kStatus GoEthernet_SetAsciiDelimiter(GoEthernet ethernet, const kChar *string)
Sets the ASCII protocol output delimiter string.
Represents a ethernet output protocol.
kBool GoEthernet_TimeoutEnabled(GoEthernet ethernet)
Indicates whether the ethernet connection timeout is enabled.
Represents an endian output type.
GoImplicitTriggerOverride GoEthernet_EIPImplicitTriggerOverride(GoEthernet ethernet)
Returns the value of the EthernetIP protocol implicit trigger override.
GoEventType GoEthernet_EventAt(GoEthernet ethernet, kSize index)
Gets the output event associated with the specified index.
Represents a composite data source.
Definition: GoSdkDef.h:947
kChar * GoEthernet_AsciiDelimiter(GoEthernet ethernet)
Gets the ASCII protocol output delimiter string.
kStatus GoEthernet_SetAsciiCustomDataFormat(GoEthernet ethernet, const kChar *string)
Sets the ASCII protocol output custom data format string.
kStatus GoEthernet_SetAsciiInvalidValue(GoEthernet ethernet, const kChar *string)
Sets the ASCII protocol output invalid value string.
k64f GoEthernet_Timeout(GoEthernet ethernet)
Returns the connection timeout value in minutes.
kStatus GoEthernet_SetAsciiControlPort(GoEthernet ethernet, k32u port)
Sets the port number of the ASCII control port.
GoAsciiOperation GoEthernet_AsciiOperation(GoEthernet ethernet)
Gets the ASCII protocol operational mode.
Essential SDK declarations.
kStatus GoEthernet_EnableTimeout(GoEthernet ethernet, kBool value)
Enables or disables the ethernet connection timeout.
kSize GoEthernet_CompositeOptionCount(GoEthernet ethernet, GoOutputSource type)
Gets the number of composite source options for the specified output type.
k32u GoEthernet_AsciiHealthPort(GoEthernet ethernet)
Gets the ASCII protocol health channel port number.
Represents an EthernetIP implicit messaging trigger override.
kSize GoEthernet_CompositeSourceCount(GoEthernet ethernet, GoOutputSource type)
Gets the number of composite sources of the specified output type that are currently selected for tra...
kStatus GoEthernet_ClearSources(GoEthernet ethernet, GoOutputSource type)
Removes (deselects) all selected sources for the specified output type.
Represents an ASCII standard format type.
kStatus GoEthernet_SetTimeout(GoEthernet ethernet, k64f value)
Sets the connection timeout value.
Represents output sources.
kStatus GoEthernet_EnableAsciiCustomFormat(GoEthernet ethernet, kBool enabled)
Enables or disables the ASCII protocol output custom data format.
GoEthernetProtocol GoEthernet_Protocol(GoEthernet ethernet)
Gets the protocol that the ethernet utilizes for output.
GoEventType GoEthernet_EventOptionAt(GoEthernet ethernet, kSize index)
Gets the event option at the specified index.
Represents an ASCII protocol operational type.
kStatus GoEthernet_SetEIPBufferingEnabled(GoEthernet ethernet, kBool enabled)
Enables or disables EthernetIP protocol output buffering.
k32u GoEthernet_OptionAt(GoEthernet ethernet, GoOutputSource type, kSize index)
Gets the source option at the specified index.
const kIpAddress * GoEthernet_ProfinetIpAddress(GoEthernet ethernet)
Returns the IP address of the Profinet protocol device.
kStatus GoEthernet_AddEvent(GoEthernet ethernet, GoEventType type)
Selects the specified event for transmission.
kStatus GoEthernet_SetAsciiTerminator(GoEthernet ethernet, const kChar *string)
Sets the ASCII protocol output terminator string.
kStatus GoEthernet_RemoveCompositeSource(GoEthernet ethernet, GoOutputSource type, kSize index)
Removes (deselects) the composite source at the specified index.
kStatus GoEthernet_SetAsciiOperation(GoEthernet ethernet, GoAsciiOperation mode)
Sets the ASCII operation mode.
kStatus GoEthernet_AddSource(GoEthernet ethernet, GoOutputSource type, k32s sourceId)
Selects the specified source for transmission.
k32u GoEthernet_SourceAt(GoEthernet ethernet, GoOutputSource type, kSize index)
Gets the identifier of the selected output at the specified index.
kStatus GoEthernet_SetModbusBufferingEnabled(GoEthernet ethernet, kBool enabled)
Enables or disables Modbus protocol output buffering.
Represents the event type represented by an event message.
kBool GoEthernet_EIPEndianOutputType(GoEthernet ethernet)
Returns the value of the EthernetIP protocol endian output type.
const kIpAddress * GoEthernet_ProfinetGateway(GoEthernet ethernet)
Returns the IP gateway address of the Profinet protocol device.
kStatus GoEthernet_SetEIPEndianOutputType(GoEthernet ethernet, GoEndianType type)
Sets the EthernetIP protocol endian output type.
kStatus GoEthernet_SetAsciiDataPort(GoEthernet ethernet, k32u port)
Sets the port number of the ASCII data port.
Represents Ethernet output settings.
kBool GoEthernet_TimeoutEnabledIsAvailable(GoEthernet ethernet)
Indicates whether ethernet connection timeout is supported or not by the ethernet protocol...
kBool GoEthernet_EIPBufferingEnabled(GoEthernet ethernet)
Returns the value of whether the EthernetIP protocol output buffering is enabled or disabled...
kStatus GoEthernet_RemoveEvent(GoEthernet ethernet, kSize index)
Removes (deselects) the Event at the specified index.
kSize GoEthernet_SourceCount(GoEthernet ethernet, GoOutputSource type)
Gets the number of sources of the specified output type that have been selected for transmission...
kSize GoEthernet_OptionCount(GoEthernet ethernet, GoOutputSource type)
Gets the number of source options for the specified output type.
kBool GoEthernet_AsciiCustomFormatEnabled(GoEthernet ethernet)
Returns the value of whether the ASCII protocol custom data format is enabled or disabled.
kBool GoEthernet_AsciiStandardFormat(GoEthernet ethernet)
Gets the current standard format mode.
const kChar * GoEthernet_ProfinetDeviceName(GoEthernet ethernet)
Returns the Profinet protocol device name.
kChar * GoEthernet_AsciiTerminator(GoEthernet ethernet)
Gets the ASCII protocol output terminator string.
kChar * GoEthernet_AsciiInvalidValue(GoEthernet ethernet)
Gets the ASCII protocol output invalid value string.