Driver of ST X-NUCLEO-OUT01A1 Industrial Digital output expansion board based on ISO8200BQ component.

Dependents:   HelloWorld_OUT01A1

Embed: (wiki syntax)

« Back to documentation index

Show/hide line numbers ISO8200BQ.h Source File

ISO8200BQ.h

Go to the documentation of this file.
00001 /**
00002  ******************************************************************************
00003  * @file    ISO8200BQ.h
00004  * @author  ST CLab
00005  * @version V1.0.0
00006  * @date    1 February 2018
00007  * @brief   Abstract class of a ISO8200BQ octal smart power solid state-relay
00008  ******************************************************************************
00009  * @attention
00010  *
00011  * <h2><center>&copy; COPYRIGHT(c) 2016 STMicroelectronics</center></h2>
00012  *
00013  * Redistribution and use in source and binary forms, with or without modification,
00014  * are permitted provided that the following conditions are met:
00015  *   1. Redistributions of source code must retain the above copyright notice,
00016  *      this list of conditions and the following disclaimer.
00017  *   2. Redistributions in binary form must reproduce the above copyright notice,
00018  *      this list of conditions and the following disclaimer in the documentation
00019  *      and/or other materials provided with the distribution.
00020  *   3. Neither the name of STMicroelectronics nor the names of its contributors
00021  *      may be used to endorse or promote products derived from this software
00022  *      without specific prior written permission.
00023  *
00024  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
00025  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00026  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
00027  * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
00028  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
00029  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
00030  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
00031  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00032  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
00033  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00034  *
00035  ******************************************************************************
00036  */
00037 
00038 
00039 /* Prevent recursive inclusion -----------------------------------------------*/
00040 
00041 #ifndef __ISO8200BQ_H__
00042 #define __ISO8200BQ_H__
00043 
00044 
00045 /* Includes ------------------------------------------------------------------*/
00046 
00047 #include <mbed.h>
00048 #include <assert.h>
00049 #include "Component.h"
00050  
00051 
00052 /* Class Declaration ---------------------------------------------------------*/
00053 
00054 /**
00055  * Abstract class of a ISO8200BQ octal smart power solid state-relay.
00056  */
00057 class ISO8200BQ : public Component
00058 {
00059   public:
00060     ISO8200BQ (PinName OUT_EN, PinName N_SYNC, 
00061         PinName N_LOAD);
00062     virtual int init(void *init);
00063     virtual int read_id(uint8_t *id);
00064     void enable_outputs(bool enable);
00065     bool are_outputs_enabled (void);
00066     void sync_mode_load_inputs (void);
00067     void sync_mode_update_outputs(void);
00068     void direct_mode (void);
00069   
00070   private:
00071     DigitalOut _out_en;
00072     DigitalOut _n_sync;
00073     DigitalOut _n_load;
00074 };
00075 
00076 #endif