Skip to content

Commit

Permalink
feat(sdr): change calibration table parameter measuredValue => adjust…
Browse files Browse the repository at this point in the history
…ment

The code updates the name of a parameter from `measuredValue` to `adjustment` across multiple classes, methods, and files. This change enhances overall code readability and clarity, enabling better understanding of the variable's purpose and use in various contexts. This modification also adjusts the documentations accordingly.
  • Loading branch information
asvol committed Nov 22, 2023
1 parent 60a9238 commit fe55ad0
Show file tree
Hide file tree
Showing 6 changed files with 19 additions and 19 deletions.
2 changes: 1 addition & 1 deletion src/Asv.Mavlink.Test/Microservices/AsvSdr/AsvSdrExTests.cs
Original file line number Diff line number Diff line change
Expand Up @@ -932,7 +932,7 @@ public async Task Client_read_calibration_table_rows(ushort count)
Assert.Equal((ulong)i, items[i].FrequencyHz);
Assert.Equal(i*0.1f, items[i].RefPower);
Assert.Equal(i*20, items[i].RefValue);
Assert.Equal(i*10, items[i].MeasuredValue);
Assert.Equal(i*10, items[i].Adjustment);
}
}

Expand Down
8 changes: 4 additions & 4 deletions src/Asv.Mavlink.Test/Microservices/AsvSdr/AsvSdrTest.cs
Original file line number Diff line number Diff line change
Expand Up @@ -761,14 +761,14 @@ public async Task Client_request_calibration_row_and_server_respond()
{
res.TableIndex = 100;
res.RowIndex = 10;
res.MeasuredValue = 100;
res.Adjustment = 100;
res.RefFreq = 200U;
res.RefValue = 300.5f;
res.RefPower = 400.0f;
});
});
var result = await clientSdr.ReadCalibrationTableRow(100, 10);
Assert.Equal(100, result.MeasuredValue);
Assert.Equal(100, result.Adjustment);
Assert.Equal(200U, result.RefFreq);
Assert.Equal(300.5f, result.RefValue);
Assert.Equal(400.0f, result.RefPower);
Expand Down Expand Up @@ -834,7 +834,7 @@ public async Task Server_callback_read_calibraion_row_and_client_respond()
{
res.TableIndex = 100;
res.RowIndex = 10;
res.MeasuredValue = 100;
res.Adjustment = 100;
res.RefFreq = 200U;
res.RefValue = 300.5f;
res.RefPower = 400.0f;
Expand All @@ -844,7 +844,7 @@ public async Task Server_callback_read_calibraion_row_and_client_respond()
});
var result = await serverSdr.CallCalibrationTableUploadReadCallback(clientSdr.Identity.SystemId,
clientSdr.Identity.ComponentId, 200, 100, 10);
Assert.Equal(100, result.MeasuredValue);
Assert.Equal(100, result.Adjustment);
Assert.Equal(200U, result.FrequencyHz);
Assert.Equal(400.0f, result.RefPower);
Assert.Equal(300.5f, result.RefValue);
Expand Down
10 changes: 5 additions & 5 deletions src/Asv.Mavlink/Microservices/AsvSdr/CalibrationTableRow.cs
Original file line number Diff line number Diff line change
Expand Up @@ -51,26 +51,26 @@ public CalibrationTableRow(AsvSdrCalibTableRowPayload result)
FrequencyHz = result.RefFreq;
RefPower = result.RefPower;
RefValue = result.RefValue;
MeasuredValue = result.MeasuredValue;
Adjustment = result.Adjustment;
}

public CalibrationTableRow(ulong frequencyHz, float refPower, float refValue, float measuredValue)
public CalibrationTableRow(ulong frequencyHz, float refPower, float refValue, float adjustment)
{
FrequencyHz = frequencyHz;
RefPower = refPower;
RefValue = refValue;
MeasuredValue = measuredValue;
Adjustment = adjustment;
}
public ulong FrequencyHz { get; set; }
public float RefPower { get;set; }
public float RefValue { get;set; }
public float MeasuredValue { get; set; }
public float Adjustment { get; set; }

public void Fill(AsvSdrCalibTableRowPayload args)
{
args.RefFreq = FrequencyHz;
args.RefPower = RefPower;
args.RefValue = RefValue;
args.MeasuredValue = MeasuredValue;
args.Adjustment = Adjustment;
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ public async Task Upload(CalibrationTableRow[] data, IProgress<double> progress
arg.RefFreq = value.FrequencyHz;
arg.RefPower = value.RefPower;
arg.RefValue = value.RefValue;
arg.MeasuredValue = value.MeasuredValue;
arg.Adjustment = value.Adjustment;
}, cancel);
});

Expand Down
2 changes: 1 addition & 1 deletion src/Asv.Mavlink/Protocol/Dialects/asv_sdr.xml
Original file line number Diff line number Diff line change
Expand Up @@ -395,7 +395,7 @@
<field type="uint64_t" name="ref_freq" >Reference frequency in Hz.</field>
<field type="float" name="ref_power">Reference power in dBm.</field>
<field type="float" name="ref_value">Reference value.</field>
<field type="float" name="measured_value">Measured value.</field>
<field type="float" name="adjustment">Adjustment for measured value (ref_value = measured_value + adjustment)</field>
</message>
<message id="13129" name="ASV_SDR_CALIB_TABLE_UPLOAD_START">
<description>Start uploading process. After that payload must send ASV_SDR_CALIB_TABLE_UPLOAD_READ_CALLBACK to client for reading table rows row_count times. Process end by payload with ASV_SDR_CALIB_ACC. [!WRAP_TO_V2_EXTENSION_PACKET!]</description>
Expand Down
14 changes: 7 additions & 7 deletions src/Asv.Mavlink/Protocol/Messages/asv_sdr.cs
Original file line number Diff line number Diff line change
Expand Up @@ -2087,7 +2087,7 @@ public class AsvSdrCalibTableRowPacket: PacketV2<AsvSdrCalibTableRowPayload>
{
public const int PacketMessageId = 13128;
public override int MessageId => PacketMessageId;
public override byte GetCrcEtra() => 103;
public override byte GetCrcEtra() => 179;
public override bool WrapToV2Extension => true;

public override AsvSdrCalibTableRowPayload Payload { get; } = new AsvSdrCalibTableRowPayload();
Expand All @@ -2108,7 +2108,7 @@ public int GetByteSize()
sum+=8; //RefFreq
sum+=4; //RefPower
sum+=4; //RefValue
sum+=4; //MeasuredValue
sum+=4; //Adjustment
sum+=2; //TableIndex
sum+=2; //RowIndex
sum+=1; //TargetSystem
Expand All @@ -2123,7 +2123,7 @@ public void Deserialize(ref ReadOnlySpan<byte> buffer)
RefFreq = BinSerialize.ReadULong(ref buffer);
RefPower = BinSerialize.ReadFloat(ref buffer);
RefValue = BinSerialize.ReadFloat(ref buffer);
MeasuredValue = BinSerialize.ReadFloat(ref buffer);
Adjustment = BinSerialize.ReadFloat(ref buffer);
TableIndex = BinSerialize.ReadUShort(ref buffer);
RowIndex = BinSerialize.ReadUShort(ref buffer);
TargetSystem = (byte)BinSerialize.ReadByte(ref buffer);
Expand All @@ -2136,7 +2136,7 @@ public void Serialize(ref Span<byte> buffer)
BinSerialize.WriteULong(ref buffer,RefFreq);
BinSerialize.WriteFloat(ref buffer,RefPower);
BinSerialize.WriteFloat(ref buffer,RefValue);
BinSerialize.WriteFloat(ref buffer,MeasuredValue);
BinSerialize.WriteFloat(ref buffer,Adjustment);
BinSerialize.WriteUShort(ref buffer,TableIndex);
BinSerialize.WriteUShort(ref buffer,RowIndex);
BinSerialize.WriteByte(ref buffer,(byte)TargetSystem);
Expand Down Expand Up @@ -2164,10 +2164,10 @@ public void Serialize(ref Span<byte> buffer)
/// </summary>
public float RefValue { get; set; }
/// <summary>
/// Measured value.
/// OriginName: measured_value, Units: , IsExtended: false
/// Adjustment for measured value (ref_value = measured_value + adjustment)
/// OriginName: adjustment, Units: , IsExtended: false
/// </summary>
public float MeasuredValue { get; set; }
public float Adjustment { get; set; }
/// <summary>
/// Table index.
/// OriginName: table_index, Units: , IsExtended: false
Expand Down

0 comments on commit fe55ad0

Please sign in to comment.