Skip to content

Commit d643df2

Browse files
committed
docs: Updated README.md and examples to include full type names
1 parent f1b3de5 commit d643df2

4 files changed

Lines changed: 23 additions & 23 deletions

File tree

README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -551,65 +551,65 @@ var daqTypes = new DaqTypeFactory(instance);
551551

552552
**C++**
553553
```cpp
554-
daq::EnumerationPtr voltage = daqTypes.MakeEnum("Voltage", "voltage_3000mV");
554+
daq::EnumerationPtr voltage = daqTypes.MakeEnum("mscl_WirelessTypes_Voltage", "voltage_3000mV");
555555
```
556556

557557
**Python**
558558
```python
559-
voltage = daq_types.enum("Voltage", "voltage_3000mV")
559+
voltage = daq_types.enum("mscl_WirelessTypes_Voltage", "voltage_3000mV")
560560
```
561561

562562
**C#**
563563
```csharp
564-
var voltage = daqTypes.MakeEnum("Voltage", "voltage_3000mV");
564+
var voltage = daqTypes.MakeEnum("mscl_WirelessTypes_Voltage", "voltage_3000mV");
565565
```
566566

567567
#### Creating a Struct value
568568

569569
**C++**
570570
```cpp
571-
daq::StructPtr cmdInfo = daqTypes.MakeStruct("ShuntCalCmdInfo",
571+
daq::StructPtr cmdInfo = daqTypes.MakeStruct("mscl_ShuntCalCmdInfo",
572572
{
573573
{"UseInternalShunt", daq::Boolean(true)},
574574
{"NumActiveGauges", daq::Integer(1)},
575575
{"GaugeResistance", daq::Integer(350)},
576576
{"ShuntResistance", daq::Integer(100000)},
577577
{"GaugeFactor", daq::Float(2.0)},
578-
{"InputRange", daqTypes.MakeEnum("InputRange", "range_14_545mV")},
578+
{"InputRange", daqTypes.MakeEnum("mscl_WirelessTypes_InputRange", "range_14_545mV")},
579579
{"HardwareOffset", daq::Integer(0)},
580-
{"ExcitationVoltage", daqTypes.MakeEnum("Voltage", "voltage_1500mV")}
580+
{"ExcitationVoltage", daqTypes.MakeEnum("mscl_WirelessTypes_Voltage", "voltage_1500mV")}
581581
});
582582
```
583583

584584
**Python**
585585
```python
586586
cmd_info = daq_types.struct(
587-
"ShuntCalCmdInfo",
587+
"mscl_ShuntCalCmdInfo",
588588
{
589589
"UseInternalShunt": True,
590590
"NumActiveGauges": 1,
591591
"GaugeResistance": 350,
592592
"ShuntResistance": 100000,
593593
"GaugeFactor": 2.0,
594-
"InputRange": daq_types.enum("InputRange", "range_14_545mV"),
594+
"InputRange": daq_types.enum("mscl_WirelessTypes_InputRange", "range_14_545mV"),
595595
"HardwareOffset": 0,
596-
"ExcitationVoltage": daq_types.enum("Voltage", "voltage_1500mV")
596+
"ExcitationVoltage": daq_types.enum("mscl_WirelessTypes_Voltage", "voltage_1500mV")
597597
}
598598
)
599599
```
600600

601601
**C#**
602602
```csharp
603-
var cmdInfo = daqTypes.MakeStruct("ShuntCalCmdInfo", new Dictionary<string, object>
603+
var cmdInfo = daqTypes.MakeStruct("mscl_ShuntCalCmdInfo", new Dictionary<string, object>
604604
{
605605
["UseInternalShunt"] = true,
606606
["NumActiveGauges"] = 1,
607607
["GaugeResistance"] = 350,
608608
["ShuntResistance"] = 100000,
609609
["GaugeFactor"] = 2.0,
610-
["InputRange"] = daqTypes.MakeEnum("InputRange", "range_14_545mV"),
610+
["InputRange"] = daqTypes.MakeEnum("mscl_WirelessTypes_InputRange", "range_14_545mV"),
611611
["HardwareOffset"] = 0,
612-
["ExcitationVoltage"] = daqTypes.MakeEnum("Voltage", "voltage_1500mV")
612+
["ExcitationVoltage"] = daqTypes.MakeEnum("mscl_WirelessTypes_Voltage", "voltage_1500mV")
613613
});
614614
```
615615

docs/WIRELESS.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,7 @@ for groups in chGroups.get_property_value('Result'):
129129

130130
for settings in groups.Settings:
131131
# If the group contains the linear equation setting
132-
if settings == daq_types.enum("ChannelGroupSetting", "chSetting_linearEquation"):
132+
if settings == daq_types.enum("mscl_WirelessTypes_ChannelGroupSetting", "chSetting_linearEquation"):
133133
# We can now pass the channel mask for this group to the function.
134134
# Note: once this channel mask is known for a specific node (+ fw version), it should never change
135135
eq = daq_utils.call(node, "Setup.Configure.Calibration.GetLinearEquation", groups.Mask)
@@ -147,10 +147,10 @@ To set current configuration settings for a node:
147147
print("\nChanging configuration settings...", end="")
148148

149149
# Set the configuration options that we want to change
150-
node.set_property_value('Setup.Configure.Power.DefaultMode', daq_types.enum("DefaultMode", "defaultMode_idle"))
150+
node.set_property_value('Setup.Configure.Power.DefaultMode', daq_types.enum("mscl_WirelessTypes_DefaultMode", "defaultMode_idle"))
151151
node.set_property_value('Setup.Configure.Power.InactivityTimeout', 7200)
152-
node.set_property_value('Control.Sample.SamplingMode', daq_types.enum("SamplingMode", "samplingMode_sync"))
153-
node.set_property_value('Control.Sample.SampleRate', daq_types.enum("WirelessSampleRate", "sampleRate_256Hz"))
152+
node.set_property_value('Control.Sample.SamplingMode', daq_types.enum("mscl_WirelessTypes_SamplingMode", "samplingMode_sync"))
153+
node.set_property_value('Control.Sample.SampleRate', daq_types.enum("mscl_WirelessTypes_WirelessSampleRate", "sampleRate_256Hz"))
154154
node.set_property_value('Control.Sample.UnlimitedDuration', True)
155155

156156
# Attempt to verify the configuration with the Node we want to apply it to

docs/examples/CPP.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ daq_utils::DaqTypeFactory daqTypes(instance);
8080

8181
daq::BaseObjectPtr chGroups = daq_utils::Call(node, "Capabilities.ChannelGroups");
8282
daq::ListPtr<daq::IBaseObject> groupsList = chGroups.asPtr<daq::IPropertyObject>().getPropertyValue("Result");
83-
daq::EnumerationPtr linearEqSetting = daqTypes.MakeEnum("ChannelGroupSetting", "chSetting_linearEquation");
83+
daq::EnumerationPtr linearEqSetting = daqTypes.MakeEnum("mscl_WirelessTypes_ChannelGroupSetting", "chSetting_linearEquation");
8484

8585
for (size_t i = 0; i < groupsList.getCount(); ++i)
8686
{
@@ -114,10 +114,10 @@ daq_utils::DaqTypeFactory daqTypes(instance);
114114
std::cout << "\nChanging configuration settings..." << "\n";
115115
116116
// Set the configuration options that we want to change
117-
node.asPtr<daq::IPropertyObject>().setPropertyValue("Setup.Configure.Power.DefaultMode", daqTypes.MakeEnum("DefaultMode", "defaultMode_idle"));
117+
node.asPtr<daq::IPropertyObject>().setPropertyValue("Setup.Configure.Power.DefaultMode", daqTypes.MakeEnum("mscl_WirelessTypes_DefaultMode", "defaultMode_idle"));
118118
node.asPtr<daq::IPropertyObject>().setPropertyValue("Setup.Configure.Power.InactivityTimeout", 7200);
119-
node.asPtr<daq::IPropertyObject>().setPropertyValue("Control.Sample.SamplingMode", daqTypes.MakeEnum("SamplingMode", "samplingMode_sync"));
120-
node.asPtr<daq::IPropertyObject>().setPropertyValue("Control.Sample.SampleRate", daqTypes.MakeEnum("WirelessSampleRate", "sampleRate_256Hz"));
119+
node.asPtr<daq::IPropertyObject>().setPropertyValue("Control.Sample.SamplingMode", daqTypes.MakeEnum("mscl_WirelessTypes_SamplingMode", "samplingMode_sync"));
120+
node.asPtr<daq::IPropertyObject>().setPropertyValue("Control.Sample.SampleRate", daqTypes.MakeEnum("mscl_WirelessTypes_WirelessSampleRate", "sampleRate_256Hz"));
121121
node.asPtr<daq::IPropertyObject>().setPropertyValue("Control.Sample.UnlimitedDuration", true);
122122
123123
// Attempt to verify the configuration with the Node we want to apply it to

docs/examples/CSHARP.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -122,10 +122,10 @@ DaqTypeFactory daqTypes = new DaqTypeFactory(instance);
122122
Console.WriteLine("\nChanging configuration settings... \n");
123123

124124
// Set the configuration options that we want to change
125-
node.Cast<PropertyObject>().SetPropertyValue("Setup.Configure.Power.DefaultMode", daqTypes.MakeEnum("DefaultMode", "defaultMode_idle"));
125+
node.Cast<PropertyObject>().SetPropertyValue("Setup.Configure.Power.DefaultMode", daqTypes.MakeEnum("mscl_WirelessTypes_DefaultMode", "defaultMode_idle"));
126126
node.Cast<PropertyObject>().SetPropertyValue("Setup.Configure.Power.InactivityTimeout", 7200);
127-
node.Cast<PropertyObject>().SetPropertyValue("Control.Sample.SamplingMode", daqTypes.MakeEnum("SamplingMode", "samplingMode_sync"));
128-
node.Cast<PropertyObject>().SetPropertyValue("Control.Sample.SampleRate", daqTypes.MakeEnum("WirelessSampleRate", "sampleRate_256Hz"));
127+
node.Cast<PropertyObject>().SetPropertyValue("Control.Sample.SamplingMode", daqTypes.MakeEnum("mscl_WirelessTypes_SamplingMode", "samplingMode_sync"));
128+
node.Cast<PropertyObject>().SetPropertyValue("Control.Sample.SampleRate", daqTypes.MakeEnum("mscl_WirelessTypes_WirelessSampleRate", "sampleRate_256Hz"));
129129
node.Cast<PropertyObject>().SetPropertyValue("Control.Sample.UnlimitedDuration", true);
130130

131131
// Attempt to verify the configuration with the Node we want to apply it to

0 commit comments

Comments
 (0)