sv_publisher.h

Go to the documentation of this file.

/*
 *  sv_publisher.h
 *
 *  Copyright 2016 Michael Zillgith
 *
 *  This file is part of libIEC61850.
 *
 *  libIEC61850 is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  libIEC61850 is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with libIEC61850.  If not, see <http://www.gnu.org/licenses/>.
 *
 *  See COPYING file for the complete license text.
 */


#ifndef LIBIEC61850_SRC_SAMPLED_VALUES_SV_PUBLISHER_H_
#define LIBIEC61850_SRC_SAMPLED_VALUES_SV_PUBLISHER_H_

#include "libiec61850_platform_includes.h"
#include "iec61850_common.h"

#ifdef __cplusplus
extern "C" {
#endif

#ifndef GOOSE_SV_COMM_PARAMETERS
#define GOOSE_SV_COMM_PARAMETERS

typedef struct sCommParameters {
    uint8_t vlanPriority;
    uint16_t vlanId;
    uint16_t appId;
    uint8_t dstAddress[6];
} CommParameters;

#endif

#define IEC61850_SV_SMPSYNC_NOT_SYNCHRONIZED 0
#define IEC61850_SV_SMPSYNC_SYNCED_UNSPEC_LOCAL_CLOCK 1
#define IEC61850_SV_SMPSYNC_SYNCED_GLOBAL_CLOCK 2

#define IEC61850_SV_SMPMOD_PER_NOMINAL_PERIOD 0
#define IEC61850_SV_SMPMOD_SAMPLES_PER_SECOND 1
#define IEC61850_SV_SMPMOD_SECONDS_PER_SAMPLE 2

typedef struct sSVPublisher* SVPublisher;

typedef struct sSVPublisher_ASDU* SVPublisher_ASDU;

SVPublisher
SVPublisher_create(CommParameters* parameters, const char* interfaceId);

SVPublisher_ASDU
SVPublisher_addASDU(SVPublisher self, const char* svID, const char* datset, uint32_t confRev);

void
SVPublisher_setupComplete(SVPublisher self);

void
SVPublisher_publish(SVPublisher self);

void
SVPublisher_destroy(SVPublisher self);

void
SVPublisher_ASDU_resetBuffer(SVPublisher_ASDU self);

int
SVPublisher_ASDU_addINT8(SVPublisher_ASDU self);

void
SVPublisher_ASDU_setINT8(SVPublisher_ASDU self, int index, int8_t value);

int
SVPublisher_ASDU_addINT32(SVPublisher_ASDU self);

void
SVPublisher_ASDU_setINT32(SVPublisher_ASDU self, int index, int32_t value);

int
SVPublisher_ASDU_addINT64(SVPublisher_ASDU self);

void
SVPublisher_ASDU_setINT64(SVPublisher_ASDU self, int index, int64_t value);

int
SVPublisher_ASDU_addFLOAT(SVPublisher_ASDU self);

void
SVPublisher_ASDU_setFLOAT(SVPublisher_ASDU self, int index, float value);

int
SVPublisher_ASDU_addFLOAT64(SVPublisher_ASDU self);

void
SVPublisher_ASDU_setFLOAT64(SVPublisher_ASDU self, int index, double value);

int
SVPublisher_ASDU_addTimestamp(SVPublisher_ASDU self);

void
SVPublisher_ASDU_setTimestamp(SVPublisher_ASDU self, int index, Timestamp value);

int
SVPublisher_ASDU_addQuality(SVPublisher_ASDU self);

void
SVPublisher_ASDU_setQuality(SVPublisher_ASDU self, int index, Quality value);

void
SVPublisher_ASDU_setSmpCnt(SVPublisher_ASDU self, uint16_t value);

uint16_t
SVPublisher_ASDU_getSmpCnt(SVPublisher_ASDU self);

void
SVPublisher_ASDU_increaseSmpCnt(SVPublisher_ASDU self);

void
SVPublisher_ASDU_setRefrTm(SVPublisher_ASDU self, uint64_t refrTm);

void
SVPublisher_ASDU_setSmpMod(SVPublisher_ASDU self, uint8_t smpMod);

void
SVPublisher_ASDU_setSmpRate(SVPublisher_ASDU self, uint16_t smpRate);

#ifndef DEPRECATED
#if defined(__GNUC__) || defined(__clang__)
  #define DEPRECATED __attribute__((deprecated))
#else
  #define DEPRECATED
#endif
#endif

typedef struct sSVPublisher* SampledValuesPublisher;

typedef struct sSV_ASDU* SV_ASDU;

DEPRECATED SVPublisher
SampledValuesPublisher_create(CommParameters* parameters, const char* interfaceId);

DEPRECATED SVPublisher_ASDU
SampledValuesPublisher_addASDU(SVPublisher self, char* svID, char* datset, uint32_t confRev);

DEPRECATED void
SampledValuesPublisher_setupComplete(SVPublisher self);

DEPRECATED void
SampledValuesPublisher_publish(SVPublisher self);

DEPRECATED void
SampledValuesPublisher_destroy(SVPublisher self);

DEPRECATED void
SV_ASDU_resetBuffer(SVPublisher_ASDU self);

DEPRECATED int
SV_ASDU_addINT8(SVPublisher_ASDU self);

DEPRECATED void
SV_ASDU_setINT8(SVPublisher_ASDU self, int index, int8_t value);

DEPRECATED int
SV_ASDU_addINT32(SVPublisher_ASDU self);

DEPRECATED void
SV_ASDU_setINT32(SVPublisher_ASDU self, int index, int32_t value);

DEPRECATED int
SV_ASDU_addINT64(SVPublisher_ASDU self);

DEPRECATED void
SV_ASDU_setINT64(SVPublisher_ASDU self, int index, int64_t value);

DEPRECATED int
SV_ASDU_addFLOAT(SVPublisher_ASDU self);

DEPRECATED void
SV_ASDU_setFLOAT(SVPublisher_ASDU self, int index, float value);

DEPRECATED int
SV_ASDU_addFLOAT64(SVPublisher_ASDU self);

DEPRECATED void
SV_ASDU_setFLOAT64(SVPublisher_ASDU self, int index, double value);

void DEPRECATED
SV_ASDU_setSmpCnt(SVPublisher_ASDU self, uint16_t value);

DEPRECATED uint16_t
SV_ASDU_getSmpCnt(SVPublisher_ASDU self);

DEPRECATED void
SV_ASDU_increaseSmpCnt(SVPublisher_ASDU self);

DEPRECATED void
SV_ASDU_setRefrTm(SVPublisher_ASDU self, uint64_t refrTm);

DEPRECATED void
SV_ASDU_setSmpMod(SVPublisher_ASDU self, uint8_t smpMod);

DEPRECATED void
SV_ASDU_setSmpRate(SVPublisher_ASDU self, uint16_t smpRate);

#ifdef __cplusplus
}
#endif

#endif /* LIBIEC61850_SRC_SAMPLED_VALUES_SV_PUBLISHER_H_ */