Akifumi Takahashi / PMRC16ch

Library to use my Photo MOS Relays Circuit having 16 or less channels.

Fork of PMRC4ch by Akifumi Takahashi

PMRC16ch.h@33:79bfee753fda, 2018-11-07 (annotated)

Committer:
aktk
Date:
Wed Nov 07 18:05:32 2018 +0000
Revision:
33:79bfee753fda
Parent:
32:94206e1da5dd
Child:
34:013746eddc4a
neko dake

Who changed what in which revision?

UserRevisionLine numberNew contents of line
aktk 15:56703876e914 1 #ifndef PMRC_16CHANNEL_H
aktk 15:56703876e914 2 #define PMRC_16CHANNEL_H
aktk 15:56703876e914 3 /**
aktk 24:4714402606f0 4 * @file PMRC16ch.h
aktk 24:4714402606f0 5 * @brief PMRC16 class header file
aktk 29:9028bc6b5717 6 * @author Akifumi Takahashi
aktk 29:9028bc6b5717 7 * @date 2016/dec/11-
aktk 31:0f491590ada9 8 * - ver.1; 8 channel
aktk 29:9028bc6b5717 9 * @date 2018/jun/01-
aktk 31:0f491590ada9 10 * - ver.16.1; 16 channel
aktk 29:9028bc6b5717 11 * @date 2018/jun/28-
aktk 31:0f491590ada9 12 * - ver.16.2; major change
aktk 29:9028bc6b5717 13 */
aktk 29:9028bc6b5717 14 #include "mbed.h"
aktk 33:79bfee753fda 15 /**
aktk 32:94206e1da5dd 16 * @class PMC16 neko
aktk 24:4714402606f0 17 * @par About PMRC16 class
aktk 26:a47ab67a4d12 18 * - A Program with which to control Photo MOS Relay Circuit
aktk 15:56703876e914 19 * for 16 channels Electric Stimulation.
aktk 26:a47ab67a4d12 20 * - Photo Couplers are controlled by Shift Resisters. So this lib serves
aktk 22:4aad836d3333 21 * shift resister's utility.
aktk 23:cea3ec410735 22 *
aktk 24:4714402606f0 23 * @par Image of Photo MOS Relay Array
aktk 25:953a60ea0e64 24 * - 32 Photo MOS Relay IN
aktk 25:953a60ea0e64 25 * - 16 channel OUT
aktk 31:0f491590ada9 26 * @code
aktk 31:0f491590ada9 27 * +--i o----+----i o--+
aktk 31:0f491590ada9 28 * | [PMR01-1] | [PMR01-2] |
aktk 31:0f491590ada9 29 * | (ch1(B)out) |
aktk 31:0f491590ada9 30 * | |
aktk 31:0f491590ada9 31 * +--i o----+----i o--+
aktk 31:0f491590ada9 32 * | [PMR02-1] | [PMR02-2] |
aktk 31:0f491590ada9 33 * | (ch2(R)out) |
aktk 31:0f491590ada9 34 * | |
aktk 31:0f491590ada9 35 * . . .
aktk 31:0f491590ada9 36 * . . .
aktk 31:0f491590ada9 37 * . . .
aktk 31:0f491590ada9 38 * Vpp GND
aktk 31:0f491590ada9 39 * @endcode
aktk 24:4714402606f0 40 *
aktk 24:4714402606f0 41 * @par Info. Shit-Resister circuit board
aktk 24:4714402606f0 42 * - nOE is connected to GND
aktk 30:6a9e4e451b42 43 * @verbatim
aktk 15:56703876e914 44 * in
aktk 15:56703876e914 45 * ->[PMR01-1]->[PMR01-2]->[PMR02-1]->[PMR02-2]
aktk 15:56703876e914 46 * ->[PMR03-1]->[PMR03-2]->[PMR04-1]->[PMR04-2]
aktk 15:56703876e914 47 * ->[PMR05-1]->[PMR05-2]->[PMR06-1]->[PMR06-2]
aktk 15:56703876e914 48 * ->[PMR07-1]->[PMR07-2]->[PMR08-1]->[PMR08-2]
aktk 15:56703876e914 49 * ->[PMR09-1]->[PMR09-2]->[PMR10-1]->[PMR10-2]
aktk 15:56703876e914 50 * ->[PMR11-1]->[PMR11-2]->[PMR12-1]->[PMR12-2]
aktk 15:56703876e914 51 * ->[PMR13-1]->[PMR13-2]->[PMR14-1]->[PMR14-2]
aktk 15:56703876e914 52 * ->[PMR15-1]->[PMR15-2]->[PMR16-1]->[PMR16-2]
aktk 15:56703876e914 53 * ->out
aktk 30:6a9e4e451b42 54 * @endverbatim
aktk 24:4714402606f0 55 *
aktk 27:a0a453783a4c 56 * @version 1
aktk 30:6a9e4e451b42 57 * -2016/dec/11-
aktk 27:a0a453783a4c 58 * @par ch.16 VER.
aktk 27:a0a453783a4c 59 * @version 16.1
aktk 30:6a9e4e451b42 60 * -2018/jun/01-
aktk 27:a0a453783a4c 61 * @version 16.2
aktk 30:6a9e4e451b42 62 * -2018/jun/28-
aktk 30:6a9e4e451b42 63 * -major change
aktk 15:56703876e914 64 */
aktk 15:56703876e914 65 class PMRC16ch
aktk 15:56703876e914 66 {
aktk 15:56703876e914 67 public:
aktk 15:56703876e914 68 //
aktk 15:56703876e914 69 // Constructor
aktk 15:56703876e914 70 //
aktk 15:56703876e914 71 PMRC16ch();
aktk 15:56703876e914 72 PMRC16ch(
aktk 21:fa067e2a30f2 73 uint8_t arg_num_ch
aktk 21:fa067e2a30f2 74 );
aktk 21:fa067e2a30f2 75 PMRC16ch(
aktk 15:56703876e914 76 uint8_t arg_num_ch,
aktk 15:56703876e914 77 PinName arg_SCK,
aktk 15:56703876e914 78 PinName arg_CLR,
aktk 15:56703876e914 79 PinName arg_RCK,
aktk 15:56703876e914 80 PinName arg_SER,
aktk 15:56703876e914 81 PinName arg_OUT
aktk 19:1112aeb5cddd 82 );
aktk 15:56703876e914 83
aktk 15:56703876e914 84 // Const.
aktk 19:1112aeb5cddd 85 enum State {
aktk 21:fa067e2a30f2 86 ALLGROUND = 0x55555555,
aktk 21:fa067e2a30f2 87 CH1 = /*1V*/0b10000000000000000000000000000000/*16G*/,
aktk 21:fa067e2a30f2 88 CH2 = /*1V*/0b00100000000000000000000000000000/*16G*/,
aktk 21:fa067e2a30f2 89 CH3 = /*1V*/0b00001000000000000000000000000000/*16G*/,
aktk 21:fa067e2a30f2 90 CH4 = /*1V*/0b00000010000000000000000000000000/*16G*/,
aktk 21:fa067e2a30f2 91 CH5 = /*1V*/0b00000000100000000000000000000000/*16G*/,
aktk 21:fa067e2a30f2 92 CH6 = /*1V*/0b00000000001000000000000000000000/*16G*/,
aktk 21:fa067e2a30f2 93 CH7 = /*1V*/0b00000000000010000000000000000000/*16G*/,
aktk 21:fa067e2a30f2 94 CH8 = /*1V*/0b00000000000000100000000000000000/*16G*/,
aktk 21:fa067e2a30f2 95 CH9 = /*1V*/0b00000000000000001000000000000000/*16G*/,
aktk 21:fa067e2a30f2 96 CH10= /*1V*/0b00000000000000000010000000000000/*16G*/,
aktk 21:fa067e2a30f2 97 CH11= /*1V*/0b00000000000000000000100000000000/*16G*/,
aktk 21:fa067e2a30f2 98 CH12= /*1V*/0b00000000000000000000001000000000/*16G*/,
aktk 21:fa067e2a30f2 99 CH13= /*1V*/0b00000000000000000000000010000000/*16G*/,
aktk 21:fa067e2a30f2 100 CH14= /*1V*/0b00000000000000000000000000100000/*16G*/,
aktk 21:fa067e2a30f2 101 CH15= /*1V*/0b00000000000000000000000000001000/*16G*/,
aktk 21:fa067e2a30f2 102 CH16= /*1V*/0b00000000000000000000000000000010/*16G*/,
aktk 21:fa067e2a30f2 103 ALLHiZ = 0x00000000
aktk 19:1112aeb5cddd 104 };
aktk 15:56703876e914 105 enum Polarity {Anodic = 0, Cathodic = 1};
aktk 21:fa067e2a30f2 106 enum StimMode {ONE_VS_THEOTHERS, TWIN_ELECTRODES};
aktk 15:56703876e914 107 //
aktk 21:fa067e2a30f2 108 // Function to prepare channels
aktk 15:56703876e914 109 //
aktk 20:26972de3cf90 110 void allGround();
aktk 15:56703876e914 111 void allHiZ();
aktk 21:fa067e2a30f2 112 void setPol(Polarity pol); //inline definition
aktk 21:fa067e2a30f2 113 void setOvsO(char ch);
aktk 21:fa067e2a30f2 114 void setTwin(char stim_ch, char ref_ch);
aktk 15:56703876e914 115 //
aktk 15:56703876e914 116 // Function to get prameter
aktk 15:56703876e914 117 //
aktk 21:fa067e2a30f2 118 uint32_t getState(); //inline definition
aktk 21:fa067e2a30f2 119 bool getPol(); //inline definition
aktk 15:56703876e914 120
aktk 15:56703876e914 121 private:
aktk 21:fa067e2a30f2 122 // The number of channels to use
aktk 21:fa067e2a30f2 123 const uint8_t m_num_ch;
aktk 15:56703876e914 124 //
aktk 15:56703876e914 125 // Sig var to controll PRM circuit
aktk 15:56703876e914 126 //
aktk 15:56703876e914 127 DigitalOut m_SCK; // Shift-resister's clock
aktk 15:56703876e914 128 DigitalOut m_CLR; // To use when you want to clear shift-resister
aktk 15:56703876e914 129 DigitalOut m_RCK; // FF's clock
aktk 15:56703876e914 130 DigitalOut m_SER; // Serial input to shift data in a shift-resister
aktk 15:56703876e914 131 DigitalIn m_OUT; // Output data overflowed from shift-resister
aktk 21:fa067e2a30f2 132 //
aktk 21:fa067e2a30f2 133 // Var of state
aktk 21:fa067e2a30f2 134 //
aktk 21:fa067e2a30f2 135 // Position of stimulation bits
aktk 21:fa067e2a30f2 136 // 0: no stimbits, 1~m_num_ch: channel of stimulation
aktk 21:fa067e2a30f2 137 uint32_t m_pos_stim;
aktk 21:fa067e2a30f2 138 static const uint32_t m_statearray[];
aktk 21:fa067e2a30f2 139 uint32_t m_PMRC_state;
aktk 21:fa067e2a30f2 140 Polarity m_PMRC_POL;
aktk 21:fa067e2a30f2 141 StimMode m_PMRC_mode;
aktk 15:56703876e914 142 // Initialization
aktk 15:56703876e914 143 void init();
aktk 15:56703876e914 144 //
aktk 21:fa067e2a30f2 145 // Function to control buffer of shift-resister
aktk 15:56703876e914 146 //
aktk 15:56703876e914 147 // shift the bits arbitary times
aktk 15:56703876e914 148 void shiftby(int times);
aktk 21:fa067e2a30f2 149 // the function with which to rapidly set it all-ground
aktk 15:56703876e914 150 void sweep();
aktk 15:56703876e914 151 // set the simulation bits of 01
aktk 15:56703876e914 152 void setStimbits();
aktk 21:fa067e2a30f2 153 // set all bits arbitarily
aktk 21:fa067e2a30f2 154 void setBits(const uint32_t bits);
aktk 21:fa067e2a30f2 155 //
aktk 21:fa067e2a30f2 156 // Clock Function
aktk 21:fa067e2a30f2 157 //
aktk 15:56703876e914 158 //update the clock of shift-resister
aktk 15:56703876e914 159 void update();
aktk 15:56703876e914 160 // output the data by uploading them to FF Resitors
aktk 15:56703876e914 161 void upload();
aktk 15:56703876e914 162 };
aktk 21:fa067e2a30f2 163 inline void PMRC16ch::setPol(Polarity arg_pol)
aktk 21:fa067e2a30f2 164 {
aktk 21:fa067e2a30f2 165 m_PMRC_POL = arg_pol;
aktk 21:fa067e2a30f2 166 }
aktk 20:26972de3cf90 167 inline uint32_t PMRC16ch::getState()
aktk 15:56703876e914 168 {
aktk 21:fa067e2a30f2 169 return m_PMRC_state;
aktk 15:56703876e914 170 }
aktk 15:56703876e914 171 inline bool PMRC16ch::getPol()
aktk 15:56703876e914 172 {
aktk 15:56703876e914 173 //return false if cathodic
aktk 15:56703876e914 174 //return true if anodic
aktk 15:56703876e914 175 return static_cast<bool>(m_PMRC_POL);
aktk 15:56703876e914 176 }
aktk 15:56703876e914 177 #endif