Skip to content

Right-align register addresses in firmware header #105

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
glopesdev merged 1 commit into from
Mar 12, 2026
Merged

Right-align register addresses in firmware header #105

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions src/AppRegs.tt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,12 +132,13 @@ foreach (var registerMetadata in DeviceMetadata.Registers)
foreach (var registerMetadata in DeviceMetadata.Registers)
{
var register = registerMetadata.Value;
var registerAddress = register.Address.ToString();
var registerName = FirmwareNamingConvention.Instance.Apply(registerMetadata.Key);
var registerType = TemplateHelper.GetFirmwareRegisterType(register.Type);
var addressOffset = new string(' ', maxRegisterNameLength - registerName.Length + 4);
var addressOffset = new string(' ', maxRegisterNameLength - registerName.Length - registerAddress.Length + 6);
var descriptionOffset = new string(' ', 7 - registerType.Length);
#>
#define ADD_REG_<#= registerName #><#= addressOffset #><#= register.Address #> // <#= registerType #><#= descriptionOffset #><#= register.Description #>
#define ADD_REG_<#= registerName #><#= addressOffset #><#= registerAddress #> // <#= registerType #><#= descriptionOffset #><#= register.Description #>
<#
}
#>
Expand Down
6 changes: 3 additions & 3 deletions tests/ExpectedOutput/device.app_ios_and_regs.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -156,8 +156,8 @@ typedef struct
#define ADD_REG_PORT_DIO_SET 41 // U8
#define ADD_REG_PULSE_DO_PORT0 42 // U16
#define ADD_REG_PULSE_DO0 43 // U16
#define ADD_REG_START_PULSE 37 // U16
#define ADD_REG_START_PULSE_TRAIN 38 // U16
#define ADD_REG_START_PULSE 100 // U16 Starts a PWM pulse.
#define ADD_REG_START_PULSE_TRAIN 101 // U16 Starts a PWM pulse train.

/************************************************************************/
/* Tests registers' memory limits */
Expand All @@ -167,7 +167,7 @@ typedef struct
/************************************************************************/
/* Memory limits */
#define APP_REGS_ADD_MIN 0x20
#define APP_REGS_ADD_MAX 0x2B
#define APP_REGS_ADD_MAX 0x65
#define APP_NBYTES_OF_REG_BANK 117

/************************************************************************/
Expand Down
40 changes: 20 additions & 20 deletions tests/ExpectedOutput/device.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,8 +49,8 @@ public Device() : base(WhoAmI) { }
{ 41, typeof(PortDIOSet) },
{ 42, typeof(PulseDOPort0) },
{ 43, typeof(PulseDO0) },
{ 37, typeof(StartPulse) },
{ 38, typeof(StartPulseTrain) }
{ 100, typeof(StartPulse) },
{ 101, typeof(StartPulseTrain) }
};

/// <summary>
Expand Down Expand Up @@ -1693,15 +1693,15 @@ public static Timestamped<ushort> GetPayload(HarpMessage message)
}

/// <summary>
/// Represents a register that manipulates messages from register StartPulse.
/// Represents a register that starts a PWM pulse.
/// </summary>
[Description("")]
[Description("Starts a PWM pulse.")]
public partial class StartPulse
{
/// <summary>
/// Represents the address of the <see cref="StartPulse"/> register. This field is constant.
/// </summary>
public const int Address = 37;
public const int Address = 100;

/// <summary>
/// Represents the payload type of the <see cref="StartPulse"/> register. This field is constant.
Expand Down Expand Up @@ -1806,15 +1806,15 @@ public static Timestamped<StartPulsePayload> GetPayload(HarpMessage message)
}

/// <summary>
/// Represents a register that manipulates messages from register StartPulseTrain.
/// Represents a register that starts a PWM pulse train.
/// </summary>
[Description("")]
[Description("Starts a PWM pulse train.")]
public partial class StartPulseTrain
{
/// <summary>
/// Represents the address of the <see cref="StartPulseTrain"/> register. This field is constant.
/// </summary>
public const int Address = 38;
public const int Address = 101;

/// <summary>
/// Represents the payload type of the <see cref="StartPulseTrain"/> register. This field is constant.
Expand Down Expand Up @@ -2738,10 +2738,10 @@ public HarpMessage GetMessage(double timestamp, MessageType messageType)

/// <summary>
/// Represents an operator that creates a message payload
/// for register StartPulse.
/// that starts a PWM pulse.
/// </summary>
[DisplayName("StartPulsePayload")]
[Description("Creates a message payload for register StartPulse.")]
[Description("Creates a message payload that starts a PWM pulse.")]
public partial class CreateStartPulsePayload
{
/// <summary>
Expand Down Expand Up @@ -2769,7 +2769,7 @@ public StartPulsePayload GetPayload()
}

/// <summary>
/// Creates a message for register StartPulse.
/// Creates a message that starts a PWM pulse.
/// </summary>
/// <param name="messageType">Specifies the type of the created message.</param>
/// <returns>A new message for the StartPulse register.</returns>
Expand All @@ -2781,14 +2781,14 @@ public HarpMessage GetMessage(MessageType messageType)

/// <summary>
/// Represents an operator that creates a timestamped message payload
/// for register StartPulse.
/// that starts a PWM pulse.
/// </summary>
[DisplayName("TimestampedStartPulsePayload")]
[Description("Creates a timestamped message payload for register StartPulse.")]
[Description("Creates a timestamped message payload that starts a PWM pulse.")]
public partial class CreateTimestampedStartPulsePayload : CreateStartPulsePayload
{
/// <summary>
/// Creates a timestamped message for register StartPulse.
/// Creates a timestamped message that starts a PWM pulse.
/// </summary>
/// <param name="timestamp">The timestamp of the message payload, in seconds.</param>
/// <param name="messageType">Specifies the type of the created message.</param>
Expand All @@ -2801,10 +2801,10 @@ public HarpMessage GetMessage(double timestamp, MessageType messageType)

/// <summary>
/// Represents an operator that creates a message payload
/// for register StartPulseTrain.
/// that starts a PWM pulse train.
/// </summary>
[DisplayName("StartPulseTrainPayload")]
[Description("Creates a message payload for register StartPulseTrain.")]
[Description("Creates a message payload that starts a PWM pulse train.")]
public partial class CreateStartPulseTrainPayload
{
/// <summary>
Expand Down Expand Up @@ -2848,7 +2848,7 @@ public StartPulseTrainPayload GetPayload()
}

/// <summary>
/// Creates a message for register StartPulseTrain.
/// Creates a message that starts a PWM pulse train.
/// </summary>
/// <param name="messageType">Specifies the type of the created message.</param>
/// <returns>A new message for the StartPulseTrain register.</returns>
Expand All @@ -2860,14 +2860,14 @@ public HarpMessage GetMessage(MessageType messageType)

/// <summary>
/// Represents an operator that creates a timestamped message payload
/// for register StartPulseTrain.
/// that starts a PWM pulse train.
/// </summary>
[DisplayName("TimestampedStartPulseTrainPayload")]
[Description("Creates a timestamped message payload for register StartPulseTrain.")]
[Description("Creates a timestamped message payload that starts a PWM pulse train.")]
public partial class CreateTimestampedStartPulseTrainPayload : CreateStartPulseTrainPayload
{
/// <summary>
/// Creates a timestamped message for register StartPulseTrain.
/// Creates a timestamped message that starts a PWM pulse train.
/// </summary>
/// <param name="timestamp">The timestamp of the message payload, in seconds.</param>
/// <param name="messageType">Specifies the type of the created message.</param>
Expand Down
6 changes: 4 additions & 2 deletions tests/Metadata/device.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,9 +128,10 @@ registers:
<<: *pulseDO
address: 43
StartPulse:
address: 37
address: 100
type: U16
access: Write
description: Starts a PWM pulse.
payloadSpec: &startPulse
DigitalOutput:
offset: 0
Expand All @@ -141,10 +142,11 @@ registers:
mask: 0x3FF
interfaceType: ushort
StartPulseTrain:
address: 38
address: 101
type: U16
length: 2
access: Write
description: Starts a PWM pulse train.
payloadSpec:
<<: *startPulse
Frequency:
Expand Down
Loading