libIEC61850  1.0.1
Open-source IEC 61850 MMS/GOOSE/SV server and client library
iec61850_client.h
Go to the documentation of this file.
1 /*
2  * iec61850_client.h
3  *
4  * Copyright 2013, 2014, 2015 Michael Zillgith
5  *
6  * This file is part of libIEC61850.
7  *
8  * libIEC61850 is free software: you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation, either version 3 of the License, or
11  * (at your option) any later version.
12  *
13  * libIEC61850 is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with libIEC61850. If not, see <http://www.gnu.org/licenses/>.
20  *
21  * See COPYING file for the complete license text.
22  */
23 
24 #ifndef IEC61850_CLIENT_H_
25 #define IEC61850_CLIENT_H_
26 
27 #ifdef __cplusplus
28 extern "C" {
29 #endif
30 
31 #include "libiec61850_common_api.h"
32 #include "iec61850_common.h"
33 #include "mms_value.h"
34 #include "mms_client_connection.h"
35 #include "linked_list.h"
36 
43 typedef struct sClientDataSet* ClientDataSet;
44 
46 typedef struct sClientReport* ClientReport;
47 
49 typedef struct sClientReportControlBlock* ClientReportControlBlock;
50 
52 typedef struct sClientGooseControlBlock* ClientGooseControlBlock;
53 
61 typedef struct sIedConnection* IedConnection;
62 
64 typedef struct
65 {
66  int ctlNum;
67  int error;
70 
72 typedef enum
73 {
78 
80 typedef enum {
81  /* general errors */
82 
85 
88 
91 
94 
97 
100 
101  /* client side errors */
102 
105 
107 
110 
113 
114  /* service error - error reported by server */
115 
118 
121 
124 
127 
130 
133 
136 
139 
142 
145 
148 
151 
154 
157 
160 
164 
165 /**************************************************
166  * Connection creation and destruction
167  **************************************************/
168 
178 IedConnection
180 
189 void
190 IedConnection_destroy(IedConnection self);
191 
192 
202 void
203 IedConnection_setConnectTimeout(IedConnection self, uint32_t timeoutInMs);
204 
205 /**************************************************
206  * Association service
207  **************************************************/
208 
217 void
218 IedConnection_connect(IedConnection self, IedClientError* error, const char* hostname, int tcpPort);
219 
232 void
233 IedConnection_abort(IedConnection self, IedClientError* error);
234 
247 void
248 IedConnection_release(IedConnection self, IedClientError* error);
249 
257 void
258 IedConnection_close(IedConnection self);
259 
269 IedConnectionState
270 IedConnection_getState(IedConnection self);
271 
280 IedConnection_getLastApplError(IedConnection self);
281 
282 
283 typedef void (*IedConnectionClosedHandler) (void* parameter, IedConnection connection);
284 
292 void
294  void* parameter);
295 
307 IedConnection_getMmsConnection(IedConnection self);
308 
318 #define IEC61850_SV_OPT_REFRESH_TIME 1
319 
321 #define IEC61850_SV_OPT_SAMPLE_SYNC 2
322 
324 #define IEC61850_SV_OPT_SAMPLE_RATE 4
325 
327 #define IEC61850_SV_OPT_DATA_SET 8
328 
330 #define IEC61850_SV_OPT_SECURITY 16
331 
332 
334 typedef struct sClientSVControlBlock* ClientSVControlBlock;
335 
347 ClientSVControlBlock
348 ClientSVControlBlock_create(IedConnection connection, const char* reference);
349 
355 void
356 ClientSVControlBlock_destroy(ClientSVControlBlock self);
357 
358 bool
359 ClientSVControlBlock_isMulticast(ClientSVControlBlock self);
360 
369 ClientSVControlBlock_getLastComError(ClientSVControlBlock self);
370 
371 
372 bool
373 ClientSVControlBlock_setSvEna(ClientSVControlBlock self, bool svEna);
374 
375 bool
376 ClientSVControlBlock_getSvEna(ClientSVControlBlock self);
377 
378 bool
379 ClientSVControlBlock_setResv(ClientSVControlBlock self, bool svEna);
380 
381 bool
382 ClientSVControlBlock_getResv(ClientSVControlBlock self);
383 
384 char*
385 ClientSVControlBlock_getMsvID(ClientSVControlBlock self);
386 
398 char*
399 ClientSVControlBlock_getDatSet(ClientSVControlBlock self);
400 
401 uint32_t
402 ClientSVControlBlock_getConfRev(ClientSVControlBlock self);
403 
404 uint16_t
405 ClientSVControlBlock_getSmpRate(ClientSVControlBlock self);
406 
407 
414 ClientSVControlBlock_getDstAddress(ClientSVControlBlock self);
415 
421 int
422 ClientSVControlBlock_getOptFlds(ClientSVControlBlock self);
423 
429 uint8_t
430 ClientSVControlBlock_getSmpMod(ClientSVControlBlock self);
431 
437 int
438 ClientSVControlBlock_getNoASDU(ClientSVControlBlock self);
439 
440 
449 /*********************************************************
450  * GOOSE services handling (MMS part)
451  ********************************************************/
452 
454 #define GOCB_ELEMENT_GO_ENA 1
455 
457 #define GOCB_ELEMENT_GO_ID 2
458 
460 #define GOCB_ELEMENT_DATSET 4
461 
463 #define GOCB_ELEMENT_CONF_REV 8
464 
466 #define GOCB_ELEMENT_NDS_COMM 16
467 
469 #define GOCB_ELEMENT_DST_ADDRESS 32
470 
472 #define GOCB_ELEMENT_MIN_TIME 64
473 
475 #define GOCB_ELEMENT_MAX_TIME 128
476 
478 #define GOCB_ELEMENT_FIXED_OFFS 256
479 
481 #define GOCB_ELEMENT_ALL 511
482 
483 
484 /**************************************************
485  * ClientGooseControlBlock class
486  **************************************************/
487 
488 ClientGooseControlBlock
489 ClientGooseControlBlock_create(const char* dataAttributeReference);
490 
491 void
492 ClientGooseControlBlock_destroy(ClientGooseControlBlock self);
493 
494 bool
495 ClientGooseControlBlock_getGoEna(ClientGooseControlBlock self);
496 
497 void
498 ClientGooseControlBlock_setGoEna(ClientGooseControlBlock self, bool goEna);
499 
500 const char*
501 ClientGooseControlBlock_getGoID(ClientGooseControlBlock self);
502 
503 void
504 ClientGooseControlBlock_setGoID(ClientGooseControlBlock self, const char* goID);
505 
506 const char*
507 ClientGooseControlBlock_getDatSet(ClientGooseControlBlock self);
508 
509 void
510 ClientGooseControlBlock_setDatSet(ClientGooseControlBlock self, const char* datSet);
511 
512 uint32_t
513 ClientGooseControlBlock_getConfRev(ClientGooseControlBlock self);
514 
515 bool
516 ClientGooseControlBlock_getNdsComm(ClientGooseControlBlock self);
517 
518 uint32_t
519 ClientGooseControlBlock_getMinTime(ClientGooseControlBlock self);
520 
521 uint32_t
522 ClientGooseControlBlock_getMaxTime(ClientGooseControlBlock self);
523 
524 bool
525 ClientGooseControlBlock_getFixedOffs(ClientGooseControlBlock self);
526 
527 MmsValue* /* MMS_OCTET_STRING */
528 ClientGooseControlBlock_getDstAddress_addr(ClientGooseControlBlock self);
529 
530 void
531 ClientGooseControlBlock_setDstAddress_addr(ClientGooseControlBlock self, MmsValue* macAddr);
532 
533 uint8_t
534 ClientGooseControlBlock_getDstAddress_priority(ClientGooseControlBlock self);
535 
536 void
537 ClientGooseControlBlock_setDstAddress_priority(ClientGooseControlBlock self, uint8_t priorityValue);
538 
539 uint16_t
540 ClientGooseControlBlock_getDstAddress_vid(ClientGooseControlBlock self);
541 
542 void
543 ClientGooseControlBlock_setDstAddress_vid(ClientGooseControlBlock self, uint16_t vidValue);
544 
545 uint16_t
546 ClientGooseControlBlock_getDstAddress_appid(ClientGooseControlBlock self);
547 
548 void
549 ClientGooseControlBlock_setDstAddress_appid(ClientGooseControlBlock self, uint16_t appidValue);
550 
551 
552 /*********************************************************
553  * GOOSE services (access to GOOSE Control Blocks (GoCB))
554  ********************************************************/
555 
583 ClientGooseControlBlock
584 IedConnection_getGoCBValues(IedConnection self, IedClientError* error, const char* goCBReference, ClientGooseControlBlock updateGoCB);
585 
607 void
608 IedConnection_setGoCBValues(IedConnection self, IedClientError* error, ClientGooseControlBlock goCB,
609  uint32_t parametersMask, bool singleRequest);
610 
613 /********************************************
614  * Reporting services
615  ********************************************/
616 
656 ClientReportControlBlock
657 IedConnection_getRCBValues(IedConnection self, IedClientError* error, const char* rcbReference,
658  ClientReportControlBlock updateRcb);
659 
661 typedef enum {
664 
667 
670 
673 
676 
679 
683 
684 #define REASON_NOT_INCLUDED IEC61850_REASON_NOT_INCLUDED
685 #define REASON_DATA_CHANGE IEC61850_REASON_DATA_CHANGE
686 #define REASON_QUALITY_CHANGE IEC61850_REASON_QUALITY_CHANGE
687 #define REASON_DATA_UPDATE IEC61850_REASON_DATA_UPDATE
688 #define REASON_INTEGRITY IEC61850_REASON_INTEGRITY
689 #define REASON_GI IEC61850_REASON_GI
690 #define REASON_UNKNOWN IEC61850_REASON_UNKNOWN
691 
692 
693 /* Element encoding mask values for ClientReportControlBlock */
694 
696 #define RCB_ELEMENT_RPT_ID 1
697 
699 #define RCB_ELEMENT_RPT_ENA 2
700 
702 #define RCB_ELEMENT_RESV 4
703 
705 #define RCB_ELEMENT_DATSET 8
706 
708 #define RCB_ELEMENT_CONF_REV 16
709 
711 #define RCB_ELEMENT_OPT_FLDS 32
712 
714 #define RCB_ELEMENT_BUF_TM 64
715 
717 #define RCB_ELEMENT_SQ_NUM 128
718 
720 #define RCB_ELEMENT_TRG_OPS 256
721 
723 #define RCB_ELEMENT_INTG_PD 512
724 
726 #define RCB_ELEMENT_GI 1024
727 
729 #define RCB_ELEMENT_PURGE_BUF 2048
730 
732 #define RCB_ELEMENT_ENTRY_ID 4096
733 
735 #define RCB_ELEMENT_TIME_OF_ENTRY 8192
736 
738 #define RCB_ELEMENT_RESV_TMS 16384
739 
741 #define RCB_ELEMENT_OWNER 32768
742 
764 void
765 IedConnection_setRCBValues(IedConnection self, IedClientError* error, ClientReportControlBlock rcb,
766  uint32_t parametersMask, bool singleRequest);
767 
774 typedef void (*ReportCallbackFunction) (void* parameter, ClientReport report);
775 
795 void
796 IedConnection_installReportHandler(IedConnection self, const char* rcbReference, const char* rptId, ReportCallbackFunction handler,
797  void* handlerParameter);
798 
805 void
806 IedConnection_uninstallReportHandler(IedConnection self, const char* rcbReference);
807 
817 void
818 IedConnection_triggerGIReport(IedConnection self, IedClientError* error, const char* rcbReference);
819 
820 /****************************************
821  * Access to received reports
822  ****************************************/
823 
832 const char*
833 ClientReport_getDataSetName(ClientReport self);
834 
841 MmsValue*
842 ClientReport_getDataSetValues(ClientReport self);
843 
850 char*
851 ClientReport_getRcbReference(ClientReport self);
852 
859 char*
860 ClientReport_getRptId(ClientReport self);
861 
871 ClientReport_getReasonForInclusion(ClientReport self, int elementIndex);
872 
882 MmsValue*
883 ClientReport_getEntryId(ClientReport self);
884 
892 bool
893 ClientReport_hasTimestamp(ClientReport self);
894 
895 bool
896 ClientReport_hasSeqNum(ClientReport self);
897 
898 uint16_t
899 ClientReport_getSeqNum(ClientReport self);
900 
901 bool
902 ClientReport_hasDataSetName(ClientReport self);
903 
904 bool
905 ClientReport_hasReasonForInclusion(ClientReport self);
906 
907 bool
908 ClientReport_hasConfRev(ClientReport self);
909 
910 uint32_t
911 ClientReport_getConfRev(ClientReport self);
912 
920 bool
921 ClientReport_hasBufOvfl(ClientReport self);
922 
930 bool
931 ClientReport_getBufOvfl(ClientReport self);
932 
940 bool
941 ClientReport_hasDataReference(ClientReport self);
942 
956 const char*
957 ClientReport_getDataReference(ClientReport self, int elementIndex);
958 
959 
970 uint64_t
971 ClientReport_getTimestamp(ClientReport self);
972 
980 char*
982 
983 /**************************************************
984  * ClientReportControlBlock access class
985  **************************************************/
986 
987 ClientReportControlBlock
988 ClientReportControlBlock_create(const char* rcbReference);
989 
990 void
991 ClientReportControlBlock_destroy(ClientReportControlBlock self);
992 
993 char*
994 ClientReportControlBlock_getObjectReference(ClientReportControlBlock self);
995 
996 bool
997 ClientReportControlBlock_isBuffered(ClientReportControlBlock self);
998 
999 const char*
1000 ClientReportControlBlock_getRptId(ClientReportControlBlock self);
1001 
1002 void
1003 ClientReportControlBlock_setRptId(ClientReportControlBlock self, const char* rptId);
1004 
1005 bool
1006 ClientReportControlBlock_getRptEna(ClientReportControlBlock self);
1007 
1008 void
1009 ClientReportControlBlock_setRptEna(ClientReportControlBlock self, bool rptEna);
1010 
1011 bool
1012 ClientReportControlBlock_getResv(ClientReportControlBlock self);
1013 
1014 void
1015 ClientReportControlBlock_setResv(ClientReportControlBlock self, bool resv);
1016 
1017 const char*
1018 ClientReportControlBlock_getDataSetReference(ClientReportControlBlock self);
1019 
1036 void
1037 ClientReportControlBlock_setDataSetReference(ClientReportControlBlock self, const char* dataSetReference);
1038 
1039 uint32_t
1040 ClientReportControlBlock_getConfRev(ClientReportControlBlock self);
1041 
1042 int
1043 ClientReportControlBlock_getOptFlds(ClientReportControlBlock self);
1044 
1045 void
1046 ClientReportControlBlock_setOptFlds(ClientReportControlBlock self, int optFlds);
1047 
1048 uint32_t
1049 ClientReportControlBlock_getBufTm(ClientReportControlBlock self);
1050 
1051 void
1052 ClientReportControlBlock_setBufTm(ClientReportControlBlock self, uint32_t bufTm);
1053 
1054 uint16_t
1055 ClientReportControlBlock_getSqNum(ClientReportControlBlock self);
1056 
1057 int
1058 ClientReportControlBlock_getTrgOps(ClientReportControlBlock self);
1059 
1060 void
1061 ClientReportControlBlock_setTrgOps(ClientReportControlBlock self, int trgOps);
1062 
1063 uint32_t
1064 ClientReportControlBlock_getIntgPd(ClientReportControlBlock self);
1065 
1066 void
1067 ClientReportControlBlock_setIntgPd(ClientReportControlBlock self, uint32_t intgPd);
1068 
1069 bool
1070 ClientReportControlBlock_getGI(ClientReportControlBlock self);
1071 
1072 void
1073 ClientReportControlBlock_setGI(ClientReportControlBlock self, bool gi);
1074 
1075 bool
1076 ClientReportControlBlock_getPurgeBuf(ClientReportControlBlock self);
1077 
1078 void
1079 ClientReportControlBlock_setPurgeBuf(ClientReportControlBlock self, bool purgeBuf);
1080 
1081 int16_t
1082 ClientReportControlBlock_getResvTms(ClientReportControlBlock self);
1083 
1084 void
1085 ClientReportControlBlock_setResvTms(ClientReportControlBlock self, int16_t resvTms);
1086 
1087 MmsValue* /* <MMS_OCTET_STRING> */
1088 ClientReportControlBlock_getEntryId(ClientReportControlBlock self);
1089 
1090 void
1091 ClientReportControlBlock_setEntryId(ClientReportControlBlock self, MmsValue* entryId);
1092 
1093 uint64_t
1094 ClientReportControlBlock_getEntryTime(ClientReportControlBlock self);
1095 
1096 MmsValue* /* <MMS_OCTET_STRING> */
1097 ClientReportControlBlock_getOwner(ClientReportControlBlock self);
1098 
1099 
1102 /****************************************
1103  * Data model access services
1104  ****************************************/
1105 
1122 MmsValue*
1123 IedConnection_readObject(IedConnection self, IedClientError* error, const char* dataAttributeReference, FunctionalConstraint fc);
1124 
1134 void
1135 IedConnection_writeObject(IedConnection self, IedClientError* error, const char* dataAttributeReference, FunctionalConstraint fc,
1136  MmsValue* value);
1137 
1138 
1147 bool
1148 IedConnection_readBooleanValue(IedConnection self, IedClientError* error, const char* objectReference, FunctionalConstraint fc);
1149 
1158 float
1159 IedConnection_readFloatValue(IedConnection self, IedClientError* error, const char* objectReference, FunctionalConstraint fc);
1160 
1173 char*
1174 IedConnection_readStringValue(IedConnection self, IedClientError* error, const char* objectReference, FunctionalConstraint fc);
1175 
1186 int32_t
1187 IedConnection_readInt32Value(IedConnection self, IedClientError* error, const char* objectReference, FunctionalConstraint fc);
1188 
1199 int64_t
1200 IedConnection_readInt64Value(IedConnection self, IedClientError* error, const char* objectReference, FunctionalConstraint fc);
1201 
1212 uint32_t
1213 IedConnection_readUnsigned32Value(IedConnection self, IedClientError* error, const char* objectReference, FunctionalConstraint fc);
1214 
1229 Timestamp*
1230 IedConnection_readTimestampValue(IedConnection self, IedClientError* error, const char* objectReference, FunctionalConstraint fc,
1231  Timestamp* timeStamp);
1232 
1243 Quality
1244 IedConnection_readQualityValue(IedConnection self, IedClientError* error, const char* objectReference, FunctionalConstraint fc);
1245 
1255 void
1256 IedConnection_writeBooleanValue(IedConnection self, IedClientError* error, const char* objectReference,
1257  FunctionalConstraint fc, bool value);
1258 
1268 void
1269 IedConnection_writeInt32Value(IedConnection self, IedClientError* error, const char* objectReference,
1270  FunctionalConstraint fc, int32_t value);
1271 
1281 void
1282 IedConnection_writeUnsigned32Value(IedConnection self, IedClientError* error, const char* objectReference,
1283  FunctionalConstraint fc, uint32_t value);
1284 
1294 void
1295 IedConnection_writeFloatValue(IedConnection self, IedClientError* error, const char* objectReference,
1296  FunctionalConstraint fc, float value);
1297 
1298 void
1299 IedConnection_writeVisibleStringValue(IedConnection self, IedClientError* error, const char* objectReference,
1300  FunctionalConstraint fc, char* value);
1301 
1302 void
1303 IedConnection_writeOctetString(IedConnection self, IedClientError* error, const char* objectReference,
1304  FunctionalConstraint fc, uint8_t* value, int valueLength);
1305 
1308 /****************************************
1309  * Data set handling
1310  ****************************************/
1311 
1329 ClientDataSet
1330 IedConnection_readDataSetValues(IedConnection self, IedClientError* error, const char* dataSetReference, ClientDataSet dataSet);
1331 
1349 void
1350 IedConnection_createDataSet(IedConnection self, IedClientError* error, const char* dataSetReference, LinkedList /* char* */ dataSetElements);
1351 
1365 bool
1366 IedConnection_deleteDataSet(IedConnection self, IedClientError* error, const char* dataSetReference);
1367 
1368 
1383 LinkedList /* <char*> */
1384 IedConnection_getDataSetDirectory(IedConnection self, IedClientError* error, const char* dataSetReference, bool* isDeletable);
1385 
1386 /********************************************************
1387  * Data set object (local representation of a data set)
1388  *******************************************************/
1389 
1398 void
1399 ClientDataSet_destroy(ClientDataSet self);
1400 
1415 MmsValue*
1416 ClientDataSet_getValues(ClientDataSet self);
1417 
1425 char*
1426 ClientDataSet_getReference(ClientDataSet self);
1427 
1435 int
1436 ClientDataSet_getDataSetSize(ClientDataSet self);
1437 
1440 /************************************
1441  * Control service functions
1442  ************************************/
1443 
1450 typedef struct sControlObjectClient* ControlObjectClient;
1451 
1452 typedef enum {
1458 } ControlModel;
1459 
1460 
1472 ControlObjectClient
1473 ControlObjectClient_create(const char* objectReference, IedConnection connection);
1474 
1475 void
1476 ControlObjectClient_destroy(ControlObjectClient self);
1477 
1478 char*
1479 ControlObjectClient_getObjectReference(ControlObjectClient self);
1480 
1481 ControlModel
1482 ControlObjectClient_getControlModel(ControlObjectClient self);
1483 
1493 bool
1494 ControlObjectClient_operate(ControlObjectClient self, MmsValue* ctlVal, uint64_t operTime);
1495 
1496 bool
1497 ControlObjectClient_select(ControlObjectClient self);
1498 
1507 bool
1508 ControlObjectClient_selectWithValue(ControlObjectClient self, MmsValue* ctlVal);
1509 
1510 bool
1511 ControlObjectClient_cancel(ControlObjectClient self);
1512 
1513 void
1514 ControlObjectClient_setLastApplError(ControlObjectClient self, LastApplError lastAppIError);
1515 
1517 ControlObjectClient_getLastApplError(ControlObjectClient self);
1518 
1519 void
1520 ControlObjectClient_setTestMode(ControlObjectClient self, bool value);
1521 
1522 void
1523 ControlObjectClient_setOrigin(ControlObjectClient self, const char* orIdent, int orCat);
1524 
1533 void
1534 ControlObjectClient_useConstantT(ControlObjectClient self, bool useConstantT);
1535 
1539 void
1540 ControlObjectClient_enableInterlockCheck(ControlObjectClient self);
1541 
1545 void
1546 ControlObjectClient_enableSynchroCheck(ControlObjectClient self);
1547 
1554 void
1555 ControlObjectClient_setInterlockCheck(ControlObjectClient self, bool value);
1556 
1563 void
1564 ControlObjectClient_setSynchroCheck(ControlObjectClient self, bool value);
1565 
1566 
1578 typedef void (*CommandTerminationHandler) (void* parameter, ControlObjectClient controlClient);
1579 
1580 void
1582  void* handlerParameter);
1583 
1586 /*************************************
1587  * Model discovery services
1588  ************************************/
1589 
1606 void
1607 IedConnection_getDeviceModelFromServer(IedConnection self, IedClientError* error);
1608 
1619 LinkedList /*<char*>*/
1620 IedConnection_getLogicalDeviceList(IedConnection self, IedClientError* error);
1621 
1634 LinkedList /*<char*>*/
1635 IedConnection_getServerDirectory(IedConnection self, IedClientError* error, bool getFileNames);
1636 
1650 LinkedList /*<char*>*/
1651 IedConnection_getLogicalDeviceDirectory(IedConnection self, IedClientError* error, const char* logicalDeviceName);
1652 
1653 typedef enum {
1665 } ACSIClass;
1666 
1680 LinkedList /*<char*>*/
1681 IedConnection_getLogicalNodeVariables(IedConnection self, IedClientError* error,
1682  const char* logicalNodeReference);
1683 
1700 LinkedList /*<char*>*/
1701 IedConnection_getLogicalNodeDirectory(IedConnection self, IedClientError* error,
1702  const char* logicalNodeReference, ACSIClass acsiClass);
1703 
1717 LinkedList /*<char*>*/
1718 IedConnection_getDataDirectory(IedConnection self, IedClientError* error, const char* dataReference);
1719 
1734 LinkedList /*<char*>*/
1735 IedConnection_getDataDirectoryFC(IedConnection self, IedClientError* error, const char* dataReference);
1736 
1752 LinkedList
1753 IedConnection_getDataDirectoryByFC(IedConnection self, IedClientError* error, const char* dataReference, FunctionalConstraint fc);
1754 
1769 MmsVariableSpecification*
1770 IedConnection_getVariableSpecification(IedConnection self, IedClientError* error, const char* dataAttributeReference,
1772 
1798 LinkedList /* <MmsJournalEntry> */
1799 IedConnection_queryLogByTime(IedConnection self, IedClientError* error, const char* logReference,
1800  uint64_t startTime, uint64_t endTime, bool* moreFollows);
1801 
1819 LinkedList /* <MmsJournalEntry> */
1820 IedConnection_queryLogAfter(IedConnection self, IedClientError* error, const char* logReference,
1821  MmsValue* entryID, uint64_t timeStamp, bool* moreFollows);
1822 
1823 
1824 
1833 typedef struct sFileDirectoryEntry* FileDirectoryEntry;
1834 
1835 FileDirectoryEntry
1836 FileDirectoryEntry_create(const char* fileName, uint32_t fileSize, uint64_t lastModified);
1837 
1838 void
1839 FileDirectoryEntry_destroy(FileDirectoryEntry self);
1840 
1841 char*
1842 FileDirectoryEntry_getFileName(FileDirectoryEntry self);
1843 
1844 uint32_t
1845 FileDirectoryEntry_getFileSize(FileDirectoryEntry self);
1846 
1847 uint64_t
1848 FileDirectoryEntry_getLastModified(FileDirectoryEntry self);
1849 
1850 
1869 LinkedList /*<FileDirectoryEntry>*/
1870 IedConnection_getFileDirectory(IedConnection self, IedClientError* error, const char* directoryName);
1871 
1886 typedef bool
1887 (*IedClientGetFileHandler) (void* parameter, uint8_t* buffer, uint32_t bytesRead);
1888 
1900 uint32_t
1901 IedConnection_getFile(IedConnection self, IedClientError* error, const char* fileName, IedClientGetFileHandler handler,
1902  void* handlerParameter);
1903 
1914 void
1915 IedConnection_setFile(IedConnection self, IedClientError* error, const char* sourceFilename, const char* destinationFilename);
1916 
1917 
1927 void
1928 IedConnection_deleteFile(IedConnection self, IedClientError* error, const char* fileName);
1929 
1930 
1935 #ifdef __cplusplus
1936 }
1937 #endif
1938 
1939 
1940 #endif /* IEC61850_CLIENT_H_ */
ClientReportControlBlock ClientReportControlBlock_create(const char *rcbReference)
uint32_t FileDirectoryEntry_getFileSize(FileDirectoryEntry self)
LinkedList IedConnection_queryLogAfter(IedConnection self, IedClientError *error, const char *logReference, MmsValue *entryID, uint64_t timeStamp, bool *moreFollows)
Implementation of the QueryLogAfter ACSI service.
void ClientGooseControlBlock_setDstAddress_vid(ClientGooseControlBlock self, uint16_t vidValue)
Timestamp * IedConnection_readTimestampValue(IedConnection self, IedClientError *error, const char *objectReference, FunctionalConstraint fc, Timestamp *timeStamp)
read a functional constrained data attribute (FCDA) of type Timestamp (UTC Time)
bool(* IedClientGetFileHandler)(void *parameter, uint8_t *buffer, uint32_t bytesRead)
user provided handler to receive the data of the GetFile request
Definition: iec61850_client.h:1887
bool IedConnection_readBooleanValue(IedConnection self, IedClientError *error, const char *objectReference, FunctionalConstraint fc)
read a functional constrained data attribute (FCDA) of type boolean
void ControlObjectClient_useConstantT(ControlObjectClient self, bool useConstantT)
Use a constant T parameter for all command (select, operate, cancel) of a single control sequence...
int32_t IedConnection_readInt32Value(IedConnection self, IedClientError *error, const char *objectReference, FunctionalConstraint fc)
read a functional constrained data attribute (FCDA) of type Integer or Unsigned and return the result...
void IedConnection_triggerGIReport(IedConnection self, IedClientError *error, const char *rcbReference)
Trigger a general interrogation (GI) report for the specified report control block (RCB) ...
int error
Definition: iec61850_client.h:67
uint32_t ClientGooseControlBlock_getConfRev(ClientGooseControlBlock self)
void ClientGooseControlBlock_destroy(ClientGooseControlBlock self)
bool ControlObjectClient_selectWithValue(ControlObjectClient self, MmsValue *ctlVal)
Send an select with value command to the server.
bool ClientReport_hasReasonForInclusion(ClientReport self)
void IedConnection_writeVisibleStringValue(IedConnection self, IedClientError *error, const char *objectReference, FunctionalConstraint fc, char *value)
void IedConnection_release(IedConnection self, IedClientError *error)
Release the connection.
uint64_t ClientReportControlBlock_getEntryTime(ClientReportControlBlock self)
void IedConnection_installReportHandler(IedConnection self, const char *rcbReference, const char *rptId, ReportCallbackFunction handler, void *handlerParameter)
Install a report handler function for the specified report control block (RCB)
ControlModel
Definition: iec61850_client.h:1452
void IedConnection_deleteFile(IedConnection self, IedClientError *error, const char *fileName)
Implementation of the DeleteFile ACSI service.
void ControlObjectClient_setSynchroCheck(ControlObjectClient self, bool value)
Set the value of the synchro check flag when a control command is sent.
struct sClientSVControlBlock * ClientSVControlBlock
Definition: iec61850_client.h:334
void ClientReportControlBlock_setGI(ClientReportControlBlock self, bool gi)
struct sFileDirectoryEntry * FileDirectoryEntry
Definition: iec61850_client.h:1833
uint32_t IedConnection_readUnsigned32Value(IedConnection self, IedClientError *error, const char *objectReference, FunctionalConstraint fc)
read a functional constrained data attribute (FCDA) of type Integer or Unsigned and return the result...
LinkedList IedConnection_getLogicalNodeDirectory(IedConnection self, IedClientError *error, const char *logicalNodeReference, ACSIClass acsiClass)
returns the directory of the given logical node (LN) containing elements of the specified ACSI class ...
const char * ClientReportControlBlock_getRptId(ClientReportControlBlock self)
struct sMmsConnection * MmsConnection
Definition: mms_client_connection.h:67
LinkedList IedConnection_getLogicalNodeVariables(IedConnection self, IedClientError *error, const char *logicalNodeReference)
returns a list of all MMS variables that are children of the given logical node
Definition: iec61850_client.h:1658
Definition: iec61850_client.h:126
void IedConnection_writeOctetString(IedConnection self, IedClientError *error, const char *objectReference, FunctionalConstraint fc, uint8_t *value, int valueLength)
LinkedList IedConnection_getFileDirectory(IedConnection self, IedClientError *error, const char *directoryName)
returns the directory entries of the specified file directory.
uint32_t ClientSVControlBlock_getConfRev(ClientSVControlBlock self)
bool ControlObjectClient_select(ControlObjectClient self)
Definition: iec61850_common.h:41
bool ClientGooseControlBlock_getNdsComm(ClientGooseControlBlock self)
uint16_t Quality
Definition: iec61850_common.h:266
char * ClientSVControlBlock_getDatSet(ClientSVControlBlock self)
Get the (MMS) reference to the data set.
void IedConnection_abort(IedConnection self, IedClientError *error)
Abort the connection.
Definition: iec61850_client.h:106
Definition: iec61850_client.h:1654
const char * ClientReport_getDataReference(ClientReport self, int elementIndex)
get the data-reference of the element of the report data set
Definition: iec61850_client.h:99
Definition: iec61850_client.h:74
LinkedList IedConnection_getDataDirectoryByFC(IedConnection self, IedClientError *error, const char *dataReference, FunctionalConstraint fc)
returns the directory of the given data object/data attribute with the given FC
void ClientReportControlBlock_setResv(ClientReportControlBlock self, bool resv)
LinkedList IedConnection_getServerDirectory(IedConnection self, IedClientError *error, bool getFileNames)
Get the list of logical devices or files available at the server.
LinkedList IedConnection_getDataSetDirectory(IedConnection self, IedClientError *error, const char *dataSetReference, bool *isDeletable)
returns the object references of the elements of a data set
Definition: iec61850_client.h:129
ReasonForInclusion
Definition: iec61850_client.h:661
Definition: iec61850_client.h:84
MmsValue * ClientReport_getEntryId(ClientReport self)
get the entry ID of the report
bool ControlObjectClient_operate(ControlObjectClient self, MmsValue *ctlVal, uint64_t operTime)
Send an operate command to the server.
void ClientSVControlBlock_destroy(ClientSVControlBlock self)
Free all resources related to the ClientSVControlBlock instance.
void ClientDataSet_destroy(ClientDataSet self)
destroy an ClientDataSet instance. Has to be called by the application.
Definition: iec61850_client.h:144
uint8_t ClientGooseControlBlock_getDstAddress_priority(ClientGooseControlBlock self)
uint16_t ClientReport_getSeqNum(ClientReport self)
ReasonForInclusion ClientReport_getReasonForInclusion(ClientReport self, int elementIndex)
get the reason code (reason for inclusion) for a specific report data set element ...
int ClientSVControlBlock_getNoASDU(ClientSVControlBlock self)
returns number of ASDUs included in the SV message
void ControlObjectClient_setLastApplError(ControlObjectClient self, LastApplError lastAppIError)
char * IedConnection_readStringValue(IedConnection self, IedClientError *error, const char *objectReference, FunctionalConstraint fc)
read a functional constrained data attribute (FCDA) of type VisibleString or MmsString ...
uint32_t ClientReportControlBlock_getIntgPd(ClientReportControlBlock self)
int64_t IedConnection_readInt64Value(IedConnection self, IedClientError *error, const char *objectReference, FunctionalConstraint fc)
read a functional constrained data attribute (FCDA) of type Integer or Unsigned and return the result...
void ControlObjectClient_setTestMode(ControlObjectClient self, bool value)
Definition: iec61850_client.h:138
void ClientReportControlBlock_setEntryId(ClientReportControlBlock self, MmsValue *entryId)
const char * ClientGooseControlBlock_getGoID(ClientGooseControlBlock self)
bool ClientSVControlBlock_setResv(ClientSVControlBlock self, bool svEna)
LinkedList IedConnection_getLogicalDeviceDirectory(IedConnection self, IedClientError *error, const char *logicalDeviceName)
Get the list of logical nodes (LN) of a logical device.
void FileDirectoryEntry_destroy(FileDirectoryEntry self)
void IedConnection_connect(IedConnection self, IedClientError *error, const char *hostname, int tcpPort)
Connect to a server.
Definition: iec61850_client.h:120
bool ClientReportControlBlock_getRptEna(ClientReportControlBlock self)
bool ClientReport_hasBufOvfl(ClientReport self)
Indicates if the report contains the bufOvfl (buffer overflow) flag.
uint64_t FileDirectoryEntry_getLastModified(FileDirectoryEntry self)
IedConnectionState IedConnection_getState(IedConnection self)
return the state of the connection.
void ClientReportControlBlock_setResvTms(ClientReportControlBlock self, int16_t resvTms)
Definition: iec61850_client.h:1662
const char * ClientReport_getDataSetName(ClientReport self)
Get the name of the report data set.
Definition: iec61850_client.h:669
uint32_t ClientReportControlBlock_getConfRev(ClientReportControlBlock self)
Definition: iec61850_client.h:1657
struct sControlObjectClient * ControlObjectClient
Definition: iec61850_client.h:1450
struct sClientReportControlBlock * ClientReportControlBlock
Definition: iec61850_client.h:49
Definition: iec61850_client.h:1454
Definition: iec61850_client.h:1457
bool ClientReport_getBufOvfl(ClientReport self)
Get the value of the bufOvfl flag.
IedConnectionState
Definition: iec61850_client.h:72
int ClientDataSet_getDataSetSize(ClientDataSet self)
get the size of the data set (number of members)
LinkedList IedConnection_getDataDirectory(IedConnection self, IedClientError *error, const char *dataReference)
returns the directory of the given data object (DO)
ControlAddCause
Definition: iec61850_common.h:143
void IedConnection_writeObject(IedConnection self, IedClientError *error, const char *dataAttributeReference, FunctionalConstraint fc, MmsValue *value)
write a functional constrained data attribute (FCDA) or functional constrained data (FCD)...
Definition: iec61850_client.h:93
ControlModel ControlObjectClient_getControlModel(ControlObjectClient self)
void IedConnection_uninstallReportHandler(IedConnection self, const char *rcbReference)
uninstall a report handler function for the specified report control block (RCB)
void IedConnection_setGoCBValues(IedConnection self, IedClientError *error, ClientGooseControlBlock goCB, uint32_t parametersMask, bool singleRequest)
Write access to attributes of a GOOSE control block (GoCB) at the connected server.
float IedConnection_readFloatValue(IedConnection self, IedClientError *error, const char *objectReference, FunctionalConstraint fc)
read a functional constrained data attribute (FCDA) of type float
uint16_t ClientGooseControlBlock_getDstAddress_appid(ClientGooseControlBlock self)
ControlAddCause addCause
Definition: iec61850_client.h:68
void ClientGooseControlBlock_setDstAddress_addr(ClientGooseControlBlock self, MmsValue *macAddr)
Definition: iec61850_client.h:159
Definition: iec61850_common.h:352
uint32_t ClientReportControlBlock_getBufTm(ClientReportControlBlock self)
uint8_t ClientSVControlBlock_getSmpMod(ClientSVControlBlock self)
returns number of sample mode of the SV publisher
struct sClientReport * ClientReport
Definition: iec61850_client.h:46
void ClientReportControlBlock_setRptId(ClientReportControlBlock self, const char *rptId)
uint64_t ClientReport_getTimestamp(ClientReport self)
get the timestamp of the report
int ClientReportControlBlock_getOptFlds(ClientReportControlBlock self)
MmsValue * ClientReportControlBlock_getEntryId(ClientReportControlBlock self)
ACSIClass
Definition: iec61850_client.h:1653
Definition: iec61850_client.h:1661
char * ClientReportControlBlock_getObjectReference(ClientReportControlBlock self)
int ctlNum
Definition: iec61850_client.h:66
Definition: iec61850_client.h:75
Definition: iec61850_client.h:156
MmsValue * ClientGooseControlBlock_getDstAddress_addr(ClientGooseControlBlock self)
Definition: iec61850_client.h:153
Definition: iec61850_client.h:1455
bool ClientReportControlBlock_getPurgeBuf(ClientReportControlBlock self)
Definition: iec61850_client.h:87
bool ClientSVControlBlock_setSvEna(ClientSVControlBlock self, bool svEna)
Definition: iec61850_client.h:112
bool ClientReportControlBlock_isBuffered(ClientReportControlBlock self)
int ClientReportControlBlock_getTrgOps(ClientReportControlBlock self)
uint32_t ClientReport_getConfRev(ClientReport self)
uint16_t ClientReportControlBlock_getSqNum(ClientReportControlBlock self)
uint16_t ClientGooseControlBlock_getDstAddress_vid(ClientGooseControlBlock self)
uint32_t IedConnection_getFile(IedConnection self, IedClientError *error, const char *fileName, IedClientGetFileHandler handler, void *handlerParameter)
Implementation of the GetFile ACSI service.
LastApplError ControlObjectClient_getLastApplError(ControlObjectClient self)
Definition: iec61850_client.h:1656
void IedConnection_createDataSet(IedConnection self, IedClientError *error, const char *dataSetReference, LinkedListdataSetElements)
create a new data set at the connected server device
LastApplError IedConnection_getLastApplError(IedConnection self)
Access to last application error received by the client connection.
MmsValue * ClientReport_getDataSetValues(ClientReport self)
return the received data set values of the report
void IedConnection_setFile(IedConnection self, IedClientError *error, const char *sourceFilename, const char *destinationFilename)
Implementation of the SetFile ACSI service.
Definition: iec61850_client.h:132
struct sClientGooseControlBlock * ClientGooseControlBlock
Definition: iec61850_client.h:52
Definition: iec61850_client.h:117
Definition: iec61850_client.h:76
FileDirectoryEntry FileDirectoryEntry_create(const char *fileName, uint32_t fileSize, uint64_t lastModified)
bool IedConnection_deleteDataSet(IedConnection self, IedClientError *error, const char *dataSetReference)
delete a deletable data set at the connected server device
void IedConnection_writeInt32Value(IedConnection self, IedClientError *error, const char *objectReference, FunctionalConstraint fc, int32_t value)
write a functional constrained data attribute (FCDA) of type integer
Definition: iec61850_client.h:147
bool ClientReport_hasConfRev(ClientReport self)
bool ClientReport_hasDataSetName(ClientReport self)
char * ClientSVControlBlock_getMsvID(ClientSVControlBlock self)
void IedConnection_destroy(IedConnection self)
destroy an IedConnection instance.
void ClientReportControlBlock_setTrgOps(ClientReportControlBlock self, int trgOps)
Definition: iec61850_client.h:663
bool ClientReport_hasTimestamp(ClientReport self)
determine if the last received report contains a timestamp
ClientGooseControlBlock ClientGooseControlBlock_create(const char *dataAttributeReference)
bool ClientSVControlBlock_getResv(ClientSVControlBlock self)
char * ControlObjectClient_getObjectReference(ControlObjectClient self)
Definition: iec61850_client.h:109
ClientSVControlBlock ClientSVControlBlock_create(IedConnection connection, const char *reference)
Create a new ClientSVControlBlock instance.
Definition: iec61850_client.h:96
void ClientReportControlBlock_setBufTm(ClientReportControlBlock self, uint32_t bufTm)
Definition: iec61850_client.h:162
LinkedList IedConnection_getDataDirectoryFC(IedConnection self, IedClientError *error, const char *dataReference)
returns the directory of the given data object (DO)
bool ClientReportControlBlock_getResv(ClientReportControlBlock self)
bool ClientGooseControlBlock_getFixedOffs(ClientGooseControlBlock self)
MmsConnection IedConnection_getMmsConnection(IedConnection self)
get a handle to the underlying MmsConnection
Definition: iec61850_client.h:1456
bool ClientGooseControlBlock_getGoEna(ClientGooseControlBlock self)
void ClientReportControlBlock_setOptFlds(ClientReportControlBlock self, int optFlds)
Definition: iec61850_client.h:681
void ClientReportControlBlock_destroy(ClientReportControlBlock self)
bool ClientSVControlBlock_isMulticast(ClientSVControlBlock self)
Definition: iec61850_client.h:123
void(* ReportCallbackFunction)(void *parameter, ClientReport report)
Callback function for receiving reports.
Definition: iec61850_client.h:774
void ClientGooseControlBlock_setDstAddress_priority(ClientGooseControlBlock self, uint8_t priorityValue)
void ClientGooseControlBlock_setDstAddress_appid(ClientGooseControlBlock self, uint16_t appidValue)
void ControlObjectClient_setOrigin(ControlObjectClient self, const char *orIdent, int orCat)
const char * ClientReportControlBlock_getDataSetReference(ClientReportControlBlock self)
bool ClientSVControlBlock_getSvEna(ClientSVControlBlock self)
Definition: iec61850_client.h:1663
Definition: iec61850_client.h:1659
Definition: iec61850_client.h:1660
void ClientReportControlBlock_setIntgPd(ClientReportControlBlock self, uint32_t intgPd)
void ControlObjectClient_enableInterlockCheck(ControlObjectClient self)
Definition: iec61850_client.h:672
void ClientGooseControlBlock_setDatSet(ClientGooseControlBlock self, const char *datSet)
const char * ClientGooseControlBlock_getDatSet(ClientGooseControlBlock self)
void ClientReportControlBlock_setPurgeBuf(ClientReportControlBlock self, bool purgeBuf)
void IedConnection_close(IedConnection self)
Close the connection.
ClientGooseControlBlock IedConnection_getGoCBValues(IedConnection self, IedClientError *error, const char *goCBReference, ClientGooseControlBlock updateGoCB)
Read access to attributes of a GOOSE control block (GoCB) at the connected server. A GoCB contains the configuration values for a single GOOSE publisher.
bool ClientReport_hasSeqNum(ClientReport self)
void ControlObjectClient_enableSynchroCheck(ControlObjectClient self)
void ControlObjectClient_setCommandTerminationHandler(ControlObjectClient self, CommandTerminationHandler handler, void *handlerParameter)
void ClientGooseControlBlock_setGoID(ClientGooseControlBlock self, const char *goID)
uint32_t ClientGooseControlBlock_getMaxTime(ClientGooseControlBlock self)
Definition: iec61850_client.h:678
void ClientReportControlBlock_setRptEna(ClientReportControlBlock self, bool rptEna)
char * ReasonForInclusion_getValueAsString(ReasonForInclusion reasonCode)
get the reason for inclusion of as a human readable string
void IedConnection_getDeviceModelFromServer(IedConnection self, IedClientError *error)
Retrieve the device model from the server.
Quality IedConnection_readQualityValue(IedConnection self, IedClientError *error, const char *objectReference, FunctionalConstraint fc)
read a functional constrained data attribute (FCDA) of type Quality
void(* IedConnectionClosedHandler)(void *parameter, IedConnection connection)
Definition: iec61850_client.h:283
Definition: iec61850_client.h:141
void ClientGooseControlBlock_setGoEna(ClientGooseControlBlock self, bool goEna)
uint32_t ClientGooseControlBlock_getMinTime(ClientGooseControlBlock self)
Definition: iec61850_client.h:666
char * ClientReport_getRptId(ClientReport self)
return RptId of the server RCB associated with this ClientReport object
Definition: iec61850_client.h:1664
Definition: iec61850_client.h:1453
void ControlObjectClient_destroy(ControlObjectClient self)
ClientReportControlBlock IedConnection_getRCBValues(IedConnection self, IedClientError *error, const char *rcbReference, ClientReportControlBlock updateRcb)
Read access to attributes of a report control block (RCB) at the connected server.
LinkedList IedConnection_getLogicalDeviceList(IedConnection self, IedClientError *error)
Get the list of logical devices available at the server (DEPRECATED)
void IedConnection_setConnectTimeout(IedConnection self, uint32_t timeoutInMs)
set the connect timeout in ms
void(* CommandTerminationHandler)(void *parameter, ControlObjectClient controlClient)
Private a callback handler that is invoked when a command termination message is received.
Definition: iec61850_client.h:1578
FunctionalConstraint
Definition: iec61850_common.h:202
Definition: iec61850_client.h:675
int ClientSVControlBlock_getOptFlds(ClientSVControlBlock self)
returns the OptFlds bit string as integer
struct sClientDataSet * ClientDataSet
Definition: iec61850_client.h:43
int16_t ClientReportControlBlock_getResvTms(ClientReportControlBlock self)
void ClientReportControlBlock_setDataSetReference(ClientReportControlBlock self, const char *dataSetReference)
set the data set to be observed by the RCB
bool ControlObjectClient_cancel(ControlObjectClient self)
char * ClientReport_getRcbReference(ClientReport self)
return reference (name) of the server RCB associated with this ClientReport object ...
bool ClientReportControlBlock_getGI(ClientReportControlBlock self)
PhyComAddress ClientSVControlBlock_getDstAddress(ClientSVControlBlock self)
returns the destination address of the SV publisher
Definition: iec61850_client.h:1655
IedClientError ClientSVControlBlock_getLastComError(ClientSVControlBlock self)
Return the error code of the last write or write acccess to the SVCB.
struct sIedConnection * IedConnection
Definition: iec61850_client.h:61
Definition: iec61850_client.h:150
Definition: iec61850_client.h:104
void IedConnection_writeBooleanValue(IedConnection self, IedClientError *error, const char *objectReference, FunctionalConstraint fc, bool value)
write a functional constrained data attribute (FCDA) of type boolean
uint16_t ClientSVControlBlock_getSmpRate(ClientSVControlBlock self)
bool ClientReport_hasDataReference(ClientReport self)
Indicates if the report contains data references for the reported data set members.
ClientDataSet IedConnection_readDataSetValues(IedConnection self, IedClientError *error, const char *dataSetReference, ClientDataSet dataSet)
get data set values from a server device
void IedConnection_setRCBValues(IedConnection self, IedClientError *error, ClientReportControlBlock rcb, uint32_t parametersMask, bool singleRequest)
Write access to attributes of a report control block (RCB) at the connected server.
IedConnection IedConnection_create(void)
create a new IedConnection instance
Definition: iec61850_client.h:64
char * ClientDataSet_getReference(ClientDataSet self)
Get the object reference of the data set.
MmsValue * ClientReportControlBlock_getOwner(ClientReportControlBlock self)
void IedConnection_installConnectionClosedHandler(IedConnection self, IedConnectionClosedHandler handler, void *parameter)
Install a handler function that will be called when the connection is lost.
char * FileDirectoryEntry_getFileName(FileDirectoryEntry self)
void IedConnection_writeUnsigned32Value(IedConnection self, IedClientError *error, const char *objectReference, FunctionalConstraint fc, uint32_t value)
write a functional constrained data attribute (FCDA) of type unsigned (integer)
MmsValue * IedConnection_readObject(IedConnection self, IedClientError *error, const char *dataAttributeReference, FunctionalConstraint fc)
read a functional constrained data attribute (FCDA) or functional constrained data (FCD)...
Definition: iec61850_client.h:135
MmsVariableSpecification * IedConnection_getVariableSpecification(IedConnection self, IedClientError *error, const char *dataAttributeReference, FunctionalConstraint fc)
return the MMS variable type specification of the data attribute referenced by dataAttributeReference...
ControlObjectClient ControlObjectClient_create(const char *objectReference, IedConnection connection)
Create a new client control object.
void IedConnection_writeFloatValue(IedConnection self, IedClientError *error, const char *objectReference, FunctionalConstraint fc, float value)
write a functional constrained data attribute (FCDA) of type float
MmsValue * ClientDataSet_getValues(ClientDataSet self)
get the data set values locally stored in the ClientDataSet instance.
void ControlObjectClient_setInterlockCheck(ControlObjectClient self, bool value)
Set the value of the interlock check flag when a control command is sent.
struct sMmsValue MmsValue
Definition: mms_value.h:68
Definition: iec61850_client.h:90
LinkedList IedConnection_queryLogByTime(IedConnection self, IedClientError *error, const char *logReference, uint64_t startTime, uint64_t endTime, bool *moreFollows)
Implementation of the QueryLogByTime ACSI service.
IedClientError
Definition: iec61850_client.h:80