cs101_master.h

Go to the documentation of this file.

/*
 *  cs101_master.h
 *
 *  Copyright 2017-2022 Michael Zillgith
 *
 *  This file is part of lib60870-C
 *
 *  lib60870-C 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.
 *
 *  lib60870-C 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 lib60870-C.  If not, see <http://www.gnu.org/licenses/>.
 *
 *  See COPYING file for the complete license text.
 */
 
#ifndef SRC_INC_API_CS101_MASTER_H_
#define SRC_INC_API_CS101_MASTER_H_
 
#include "iec60870_master.h"
#include "link_layer_parameters.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef struct sCS101_Master* CS101_Master;
 
CS101_Master
CS101_Master_create(SerialPort port, const LinkLayerParameters llParameters, const CS101_AppLayerParameters alParameters, IEC60870_LinkLayerMode mode);
 
CS101_Master
CS101_Master_createEx(SerialPort serialPort, const LinkLayerParameters llParameters, const CS101_AppLayerParameters alParameters, IEC60870_LinkLayerMode linkLayerMode,
        int queueSize);
 
void
CS101_Master_run(CS101_Master self);
 
void
CS101_Master_start(CS101_Master self);
 
void
CS101_Master_stop(CS101_Master self);
 
void
CS101_Master_addSlave(CS101_Master self, int address);
 
 
void
CS101_Master_pollSingleSlave(CS101_Master self, int address);
 
void
CS101_Master_destroy(CS101_Master self);
 
void
CS101_Master_setDIR(CS101_Master self, bool dir);
 
void
CS101_Master_setOwnAddress(CS101_Master self, int address);
 
void
CS101_Master_useSlaveAddress(CS101_Master self, int address);
 
 
 
CS101_AppLayerParameters
CS101_Master_getAppLayerParameters(CS101_Master self);
 
LinkLayerParameters
CS101_Master_getLinkLayerParameters(CS101_Master self);
 
bool
CS101_Master_isChannelReady(CS101_Master self, int address);
 
void
CS101_Master_sendLinkLayerTestFunction(CS101_Master self);
 
void
CS101_Master_sendInterrogationCommand(CS101_Master self, CS101_CauseOfTransmission cot, int ca, QualifierOfInterrogation qoi);
 
void
CS101_Master_sendCounterInterrogationCommand(CS101_Master self, CS101_CauseOfTransmission cot, int ca, uint8_t qcc);
 
void
CS101_Master_sendReadCommand(CS101_Master self, int ca, int ioa);
 
void
CS101_Master_sendClockSyncCommand(CS101_Master self, int ca, CP56Time2a time);
 
void
CS101_Master_sendTestCommand(CS101_Master self, int ca);
 
void
CS101_Master_sendProcessCommand(CS101_Master self, CS101_CauseOfTransmission cot, int ca, InformationObject command);
 
 
void
CS101_Master_sendASDU(CS101_Master self, CS101_ASDU asdu);
 
void
CS101_Master_setASDUReceivedHandler(CS101_Master self, CS101_ASDUReceivedHandler handler, void* parameter);
 
void
CS101_Master_setLinkLayerStateChanged(CS101_Master self, IEC60870_LinkLayerStateChangedHandler handler, void* parameter);
 
void
CS101_Master_setRawMessageHandler(CS101_Master self, IEC60870_RawMessageHandler handler, void* parameter);
 
void
CS101_Master_setIdleTimeout(CS101_Master self, int timeoutInMs);
 
#ifdef __cplusplus
}
#endif
 
#endif /* SRC_INC_API_CS101_MASTER_H_ */