"All yellow marked signal ports in the schematic are named as it is in the\n",
"zero model without any spaces.\n",
"Following are some useful node names to remember:\n",
"\n",
"|\tNode name\t|\tFunction/Parameter\t|\n",
"|\t---\t|\t---\t|\n",
"| ServoIn | Servo Input.|\n",
"| InMon | Input monitor.|\n",
"| OutMon | Output Monitor.|\n",
"| TP# | Test points in the main signal chain. Eg. TP4.|\n",
"| J3A | Servo Input BNC port.|\n",
"| J1A | Piezo BNC port.|\n",
"\n",
"The model provides options of setting the variable gain, switching Boost,\n",
"and inverter switch.\n",
"\n",
"|\tFunction\t|\tWhat does it do?\t|\tArguments and usage\t|\n",
"|\t---\t|\t---\t|\t---\t|\n",
"|\tVarGain(circuit, Rpot=None, G=None, Vg=None, vb=True, R27=1e3, R26=1e3)\t|\tSet variable gain\t|\tcircuit: Circuit object <br>Rpot:R7 potentiometer setting in Ohms (0-10kOhms)<br>Vg:Gain setting voltage<br>vb: verbose<br><br>R27, R26: Resitors associated to preamplifier again in AD8336.<br>One only needs to provide one of arguments Rpot, G, or Vg.\t|\n",
"|\tBoost(circuit,state)\t|\tSwitch on or off Boost. |\tcircuit: Circuit object <br>State: 'ON' or 'OFF'\t|\n",
"|\tInverter(circuit,state)\t|\tSwitch on or off inversiont. |\tcircuit: Circuit object <br>State: 'ON' or 'OFF'\t|\n",
All yellow marked signal ports in the schematic are named as it is in the
zero model without any spaces.
Following are some useful node names to remember:
| Node name | Function/Parameter |
| --- | --- |
| ServoIn | Servo Input.|
| InMon | Input monitor.|
| OutMon | Output Monitor.|
| TP# | Test points in the main signal chain. Eg. TP4.|
| J3A | Servo Input BNC port.|
| J1A | Piezo BNC port.|
The model provides options of setting the variable gain, switching Boost,
and inverter switch.
| Function | What does it do? | Arguments and usage |
| --- | --- | --- |
| VarGain(circuit, Rpot=None, G=None, Vg=None, vb=True, R27=1e3, R26=1e3) | Set variable gain | circuit: Circuit object <br>Rpot:R7 potentiometer setting in Ohms (0-10kOhms)<br>Vg:Gain setting voltage<br>vb: verbose<br><br>R27, R26: Resitors associated to preamplifier again in AD8336.<br>One only needs to provide one of arguments Rpot, G, or Vg. |
| Boost(circuit,state) | Switch on or off Boost. | circuit: Circuit object <br>State: 'ON' or 'OFF' |
| Inverter(circuit,state) | Switch on or off inversiont. | circuit: Circuit object <br>State: 'ON' or 'OFF' |
The code is written in jupyter notebook to easily understand the flow of code
and which element (component and nodes) is which. The notebook in the end
writes a script copy of itself which we can import out of this module.
## Documentation
All yellow marked signal ports in the schematic are named as it is in the
zero model without any spaces.
Following are some useful node names to remember:
| Node name | Function/Parameter |
| --- | --- |
| ServoIn | Servo Input.|
| InMon | Input monitor.|
| OutMon | Output Monitor.|
| TP# | Test points in the main signal chain. Eg. TP4.|
| J3A | Servo Input BNC port.|
| J1A | Piezo BNC port.|
The model provides options of setting the variable gain, switching Boost,
and inverter switch.
| Function | What does it do? | Arguments and usage |
| --- | --- | --- |
| VarGain(circuit, Rpot=None, G=None, Vg=None, vb=True, R27=1e3, R26=1e3) | Set variable gain | circuit: Circuit object <br>Rpot:R7 potentiometer setting in Ohms (0-10kOhms)<br>Vg:Gain setting voltage<br>vb: verbose<br><br>R27, R26: Resitors associated to preamplifier again in AD8336.<br>One only needs to provide one of arguments Rpot, G, or Vg. |
| Boost(circuit,state) | Switch on or off Boost. | circuit: Circuit object <br>State: 'ON' or 'OFF' |
| Inverter(circuit,state) | Switch on or off inversiont. | circuit: Circuit object <br>State: 'ON' or 'OFF' |
## Contribution
Everyone's contribution towards any bug fixes and additional features are most
welcome but please make your changes in the notebook, save it and use 'restart
and run all' function to generate equivalent script copy. This will ensure that
the notebook and the script do not diverge from each other and we always have
an up-to-date notebook environment to understand the circuit. Thanks!