Gocator API

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