Akifumi Takahashi / PMRC16ch

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

Fork of PMRC4ch by Akifumi Takahashi

PMRC16ch.h@25:953a60ea0e64, 2018-11-07 (annotated)

Committer:
aktk
Date:
Wed Nov 07 17:07:23 2018 +0000
Revision:
25:953a60ea0e64
Parent:
24:4714402606f0
Child:
26:a47ab67a4d12
changed the initial comment (test);

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