385 lines
18 KiB
XML
385 lines
18 KiB
XML
<?xml version="1.0"?>
|
|
<doc>
|
|
<assembly>
|
|
<name>Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages</name>
|
|
</assembly>
|
|
<members>
|
|
<member name="T:Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.EventArguments.CalibDataEventArgs">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="F:Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.EventArguments.CalibDataEventArgs.CalibChl">
|
|
<summary>
|
|
Stream record for calibration on channel
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.EventArguments.CalibDataEventArgs.GetEventData">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="T:Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.EventArguments.BendDetectDataEventArgs">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="F:Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.EventArguments.BendDetectDataEventArgs.NewData">
|
|
<summary>
|
|
new record from Stream
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.EventArguments.BendDetectDataEventArgs.GetEventData">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="T:Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.EventArguments.FlowDataEventArgs">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="F:Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.EventArguments.FlowDataEventArgs.NewData">
|
|
<summary>
|
|
new record from Stream
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.EventArguments.FlowDataEventArgs.GetEventData">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="T:Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.EventArguments.RegisterUpdatedEventArgs">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.EventArguments.RegisterUpdatedEventArgs.#ctor(Xylem.Common.Hardware.WaterMeter.Genesis.Registers.RegisterDefinition,System.Byte[])">
|
|
<inheritdoc />
|
|
<summary>
|
|
Ctor with base record
|
|
</summary>
|
|
<param name="register">base record <see cref="F:Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.EventArguments.RegisterUpdatedEventArgs.Register" /></param>
|
|
<param name="value">base record <see cref="F:Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.EventArguments.RegisterUpdatedEventArgs.Value" /></param>
|
|
</member>
|
|
<member name="F:Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.EventArguments.RegisterUpdatedEventArgs.Register">
|
|
<summary>
|
|
Register witch has updated
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.EventArguments.RegisterUpdatedEventArgs.Value">
|
|
<summary>
|
|
New Value in Register
|
|
</summary>
|
|
</member>
|
|
<member name="T:Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.EventArguments.RequestResponseDataEventArgs">
|
|
<inheritdoc />
|
|
<summary>
|
|
EventArgs for Request Responses
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.EventArguments.RequestResponseDataEventArgs.RequestResponseData">
|
|
<summary>
|
|
Request response from meter
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.EventArguments.RequestResponseDataEventArgs.GetEventData">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="T:Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.MeasurementRecords.BendDetectionRecord">
|
|
<inheritdoc />
|
|
<summary>
|
|
Streaming record for protocol M (information about bend detection and correction)
|
|
</summary>
|
|
</member>
|
|
<member name="T:Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.MeasurementRecords.BendDetectionRecord.StatusBendU0Enum">
|
|
<summary>
|
|
The status of the U0 detection for this measurement
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.MeasurementRecords.BendDetectionRecord.StatusBendU0Enum.OKAY">
|
|
<summary>
|
|
Status okay
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.MeasurementRecords.BendDetectionRecord.StatusBendU0Enum.ERROR_GENESISFLOW_INSTALLATION_HIGH_TIME_DIFF">
|
|
<summary>
|
|
Error code as defined by field name
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.MeasurementRecords.BendDetectionRecord.StatusBendU0Enum.ERROR_GENESISFLOW_INSTALLATION_LOW_FLOW_IGNORE">
|
|
<summary>
|
|
Error code as defined by field name
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.MeasurementRecords.BendDetectionRecord.StatusBendU0Enum.ERROR_GENESISFLOW_INSTALLATION_BAD_CHANNELS">
|
|
<summary>
|
|
Error code as defined by field name
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.MeasurementRecords.BendDetectionRecord.StatusBendU0Enum.ERROR_GENESISFLOW_INSTALLATION_FIXED">
|
|
<summary>
|
|
Error code as defined by field name
|
|
</summary>
|
|
</member>
|
|
<member name="T:Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.MeasurementRecords.BendDetectionRecord.InstallationTypeEnum">
|
|
<summary>
|
|
An enum describing the installation type detected
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.MeasurementRecords.BendDetectionRecord.InstallationTypeEnum.INSTALLATION_U0_180_360">
|
|
<summary>
|
|
Installation type code as defined by field name
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.MeasurementRecords.BendDetectionRecord.InstallationTypeEnum.INSTALLATION_U0_90_270">
|
|
<summary>
|
|
Installation type code as defined by field name
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.MeasurementRecords.BendDetectionRecord.InstallationTypeEnum.INSTALLATION_UNDISTURBED">
|
|
<summary>
|
|
Installation type code as defined by field name
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.MeasurementRecords.BendDetectionRecord.StatusBendU0">
|
|
<summary>
|
|
Status of U0 Bend detection
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.MeasurementRecords.BendDetectionRecord.InstallationType">
|
|
<summary>
|
|
Installation type code
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.MeasurementRecords.BendDetectionRecord.CorrectionFactor_percent">
|
|
<summary>
|
|
The proportion of the installation correction to apply based on the detected
|
|
installation. 100% == 0x8000
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.MeasurementRecords.BendDetectionRecord.DefaultCorrectionFactor">
|
|
<summary>
|
|
The default proportion of the installation correction to apply based on the
|
|
detected installation. 100% == 0x8000
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.MeasurementRecords.BendDetectionRecord.CorrectionFactorScale">
|
|
<summary>
|
|
Scale for correction factor to apply to convert it to percentage value 100% == 0x8000
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.MeasurementRecords.BendDetectionRecord.PreCorrectionVolumeRaw">
|
|
<summary>
|
|
The volume in internal units before correction applied
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.MeasurementRecords.BendDetectionRecord.PostCorrectionVolumeRaw">
|
|
<summary>
|
|
The volume in internal units after correction applied
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.MeasurementRecords.BendDetectionRecord.ToString">
|
|
<summary>
|
|
Get result as string
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="T:Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.MeasurementRecords.CalibrationRecord">
|
|
<inheritdoc />
|
|
<summary>
|
|
hold streaming record for protocol H (contains calibration record)
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.MeasurementRecords.CalibrationRecord.Validation">
|
|
<summary>
|
|
record validation
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.MeasurementRecords.CalibrationRecord.TotalTimeOfFlightS">
|
|
<summary>
|
|
total time of flight in seconds
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.MeasurementRecords.CalibrationRecord.DeltaTimeOfFlightS">
|
|
<summary>
|
|
delta time of flight in seconds
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.MeasurementRecords.CalibrationRecord.RawTotalTimeOfFlight">
|
|
<summary>
|
|
total time of flight in cordonel units
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.MeasurementRecords.CalibrationRecord.RawDeltaTimeOfFlight">
|
|
<summary>
|
|
delta time of flight in cordonel units
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.MeasurementRecords.CalibrationRecord.VolumeScaleRawPerMl">
|
|
<summary>
|
|
volume scale (default: 1024) means
|
|
1024digits = 1ml
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.MeasurementRecords.CalibrationRecord.VolumeFactorRawToQm">
|
|
<summary>
|
|
volume factor to convert raw to m³
|
|
uses 1E-6 (ml to m³) / VolumeScaleRawPerMl
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.MeasurementRecords.CalibrationRecord.DeltaVolumeRaw">
|
|
<summary>
|
|
raw volume between two samples
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.MeasurementRecords.CalibrationRecord.DeltaVolumeQm">
|
|
<summary>
|
|
calculated out of dRawVolume * VolumeFactorRawToQm .
|
|
in cubic meters
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.MeasurementRecords.CalibrationRecord.AccuVolumeRaw">
|
|
<summary>
|
|
accumulated raw volume
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.MeasurementRecords.CalibrationRecord.SampleIntervalS">
|
|
<summary>
|
|
sample interval between two samples in seconds
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.MeasurementRecords.CalibrationRecord.AmplitudeUpV">
|
|
<summary>
|
|
high threshold amplitude in V
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.MeasurementRecords.CalibrationRecord.AmplitudeDownV">
|
|
<summary>
|
|
low threshold amplitude in V
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.MeasurementRecords.CalibrationRecord.PulseWidthRatioUp">
|
|
<summary>
|
|
high ratio for pulse width
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.MeasurementRecords.CalibrationRecord.PulseWidthRatioDown">
|
|
<summary>
|
|
low ratio for pulse width
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.MeasurementRecords.CalibrationRecord.TemperatureRaw">
|
|
<summary>
|
|
raw temperature
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.MeasurementRecords.CalibrationRecord.TemperaturePowFactor">
|
|
<summary>
|
|
temperature scale
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.MeasurementRecords.CalibrationRecord.TemperatureDegC">
|
|
<summary>
|
|
calculated temperature in degree C
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.MeasurementRecords.CalibrationRecord.ToString">
|
|
<summary>
|
|
Get result as string
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="T:Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.MeasurementRecords.FlowTestRecord">
|
|
<inheritdoc />
|
|
<summary>
|
|
struct to hold Led record for protocol F (contains measurement record)
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.MeasurementRecords.FlowTestRecord.ToString">
|
|
<summary>
|
|
Get result as string
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="T:Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.RadioConfigurationParams">
|
|
<summary>
|
|
All parameters needed for radio setup
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.RadioConfigurationParams.PcbId">
|
|
<summary>
|
|
Pcb identification
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.RadioConfigurationParams.SerialNumber">
|
|
<summary>
|
|
Serial number
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.RadioConfigurationParams.RadioAddress">
|
|
<summary>
|
|
Radio address
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.RadioConfigurationParams.PowerLevel">
|
|
<summary>
|
|
Power level
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.RadioConfigurationParams.PowerLevelOption">
|
|
<summary>
|
|
Power level option
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.RadioConfigurationParams.ImpedanceCodeNew">
|
|
<summary>
|
|
New code for impedance
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.RadioConfigurationParams.ImpedanceCodeOption">
|
|
<summary>
|
|
Impedance code option
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.RadioConfigurationParams.EncryptionKey">
|
|
<summary>
|
|
Encryption key
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.RadioConfigurationParams.FrqOffset">
|
|
<summary>
|
|
Frequency offset
|
|
</summary>
|
|
</member>
|
|
<member name="T:Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.RegisterToDb">
|
|
<summary>
|
|
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.RegisterToDb.#ctor(System.Byte[],System.Byte[])">
|
|
<summary>
|
|
Register address and value to DB
|
|
</summary>
|
|
<param name="adresse"></param>
|
|
<param name="value"></param>
|
|
</member>
|
|
<member name="F:Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.RegisterToDb.Adresse">
|
|
<summary>
|
|
Address
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.RegisterToDb.Value">
|
|
<summary>
|
|
Value
|
|
</summary>
|
|
</member>
|
|
<member name="T:Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.TempTofCalc">
|
|
<summary>
|
|
Temperature Time Of Flight calculation
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.TempTofCalc.RefDate">
|
|
<summary>
|
|
Reference data
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.TempTofCalc.RefTemp">
|
|
<summary>
|
|
Reference temperature
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.TempTofCalc.Tof">
|
|
<summary>
|
|
Time Of Flight
|
|
</summary>
|
|
</member>
|
|
</members>
|
|
</doc>
|