Gocator API

- Home
- Topics
- Types
- Files

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