Isomet Modular Synthesiser (iMS) API  v1.4.2
iMS API
Public Attributes | List of all members
iMS::StartupConfiguration Struct Reference

The Synthesiser stores in its non-volatile memory a set of configuration values that are preloaded on startup. More...

#include <include\SystemFunc.h>

Collaboration diagram for iMS::StartupConfiguration:
Collaboration graph
[legend]

Public Attributes

Percent RFAmplitudeWiper1 { 0.0 }
 Setting for RF Amplitude Control Wiper 1.
 
Percent RFAmplitudeWiper2 { 0.0 }
 Setting for RF Amplitude Control Wiper 2.
 
Percent DDSPower { 0.0 }
 Setting for DDS Powere Level.
 
SignalPath::AmplitudeControl AmplitudeControlSource { SignalPath::AmplitudeControl::WIPER_1 }
 Select which of the four control sources should be applied to the RF signal amplitude modulation.
 
bool RFGate { false }
 Switch the RF power amplifier gate signal on/off at startup.
 
bool RFBias12 { false }
 Individually enable the bias power for channels 1 and 2 at startup.
 
bool RFBias34 { false }
 Individually enable the bias power for channels 3 and 4 at startup.
 
bool ExtEquipmentEnable { false }
 Select whether to enable the external equipment optoswitch at startup.
 
SignalPath::Compensation LTBUseAmplitudeCompensation { SignalPath::Compensation::ACTIVE }
 Sets whether the LTB should use amplitude compensation from the look-up table.
 
SignalPath::Compensation LTBUsePhaseCompensation { SignalPath::Compensation::BYPASS }
 Sets whether the LTB should use phase compensation from the look-up table.
 
SignalPath::ToneBufferControl LTBControlSource { SignalPath::ToneBufferControl::OFF }
 Selects the control mode for the LTB: OFF (Image mode), host software control, external drive (16) or extended external (256)
 
std::uint8_t LocalToneIndex { 0 }
 In host mode, picks the initial setting for the Tone Buffer index.
 
Degrees PhaseTuneCh1 { 0.0 }
 Apply any phase tuning offset coefficient to the RF output on channel 1.
 
Degrees PhaseTuneCh2 { 0.0 }
 Apply any phase tuning offset coefficient to the RF output on channel 2.
 
Degrees PhaseTuneCh3 { 0.0 }
 Apply any phase tuning offset coefficient to the RF output on channel 3.
 
Degrees PhaseTuneCh4 { 0.0 }
 Apply any phase tuning offset coefficient to the RF output on channel 4.
 
bool ChannelReversal { false }
 If true, the 4 RF signals will output in reverse channel order.
 
SignalPath::Compensation ImageUseAmplitudeCompensation { SignalPath::Compensation::ACTIVE }
 Sets whether Image pixel data should use amplitude compensation from the look-up table.
 
SignalPath::Compensation ImageUsePhaseCompensation { SignalPath::Compensation::BYPASS }
 Sets whether Image pixel data should use phase compensation from the look-up table.
 
SystemFunc::UpdateClockSource upd_clk { SystemFunc::UpdateClockSource::INTERNAL }
 Configures the DDS update clock source to either be generated internally or be derived from the external Image clock input.
 
bool XYCompEnable { false }
 Enables X/Y Deflector mode in which phase compensation is applied independently to each pair of channels.
 
Auxiliary::LED_SOURCE LEDGreen { Auxiliary::LED_SOURCE::PULS }
 Configures the Green LED function.
 
Auxiliary::LED_SOURCE LEDYellow { Auxiliary::LED_SOURCE::RF_GATE }
 Configures the Yellow LED function.
 
Auxiliary::LED_SOURCE LEDRed { Auxiliary::LED_SOURCE::INTERLOCK }
 Configures the Red LED function.
 
std::uint8_t GPOutput { 0 }
 The default value to drive on the General Purpose output.
 
SystemFunc::NHFLocalReset ResetOnUnhealthy { SystemFunc::NHFLocalReset::NO_ACTION }
 Sets what action to perform if the communications channel enters an "unhealthy" state.
 
bool CommsHealthyCheckEnabled { false }
 Turns on/off the communications channel health state check.
 
unsigned int CommsHealthyCheckTimerMilliseconds { 500 }
 Timeout between communications messages after which deemed unhealthy.
 
SignalPath::SYNC_SRC SyncDigitalSource { SignalPath::SYNC_SRC::IMAGE_DIG }
 Sets the source of synchronous data applied to the digital outputs.
 
SignalPath::SYNC_SRC SyncAnalogASource { SignalPath::SYNC_SRC::IMAGE_ANLG_A }
 Sets the source of synchronous data applied to the analog A output.
 
SignalPath::SYNC_SRC SyncAnalogBSource { SignalPath::SYNC_SRC::IMAGE_ANLG_B }
 Sets the source of synchronous data applied to the analog B output.
 
SystemFunc::PLLLockReference PLLMode { SystemFunc::PLLLockReference::INTERNAL }
 Sets the default system clock mode - internally generated or slave to an external reference clock input.
 
kHz ExtClockFrequency { 1000.0 }
 Defines the external supplied reference clock frequency when manual external reference PLL mode is used.
 

Detailed Description

The Synthesiser stores in its non-volatile memory a set of configuration values that are preloaded on startup.

Modify the values present in this struct and pass the struct by reference to the SystemFunc::StoreStartupConfig() function to overwrite the existing startup configuration parameters

e.g.

SystemFunc sys(myiMS);
StartupConfiguration cfg;
cfg.DDSPower = 100.0;
sys.StoreStartupConfig(cfg);
Since
1.1

The documentation for this struct was generated from the following file: