Skip to content
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

fix openlcb velocity 14 28 ss conversions #804

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

fix openlcb velocity 14 28 ss conversions #804

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c542954
Fix incorrect 14/28 speed step conversion factors.
bakerstu Jan 2, 2025
77755ca
Fix/add tests.
bakerstu Jan 2, 2025
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
22 changes: 12 additions & 10 deletions src/openlcb/Velocity.cxx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,17 +99,18 @@ void Velocity::set_dcc_128(uint8_t value)
* bit 7..6: fixed at b'01'
* bit 5: direction
* bits 4: speed step least significant bit
* bits 3..0: speed step significatn bits 4..1
* bits 3..0: speed step significant bits 4..1
* @return DCC encoded speed steps
*/
uint8_t Velocity::get_dcc_28()
{
uint8_t result;
uint32_t tmp = ((speed() * MPH_FACTOR * 28) / 128) + 0.5;
uint32_t tmp = ((speed() * 28) / (128 * MPH_FACTOR)) + 0.5;

if (tmp == 0)
{
result = 0;
// If input speed is not zero, make actual speed step at least 1.
result = speed() == 0 ? 0 : 4;
}
else if (tmp > 28)
{
Expand All @@ -134,7 +135,7 @@ uint8_t Velocity::get_dcc_28()
* @param value bit 7..6: fixed at b'01'
* bit 5: direction
* bits 4: speed step least significant bit
* bits 3..0: speed step significatn bits 4..1
* bits 3..0: speed step significant bits 4..1
*/
void Velocity::set_dcc_28(uint8_t value)
{
Expand All @@ -149,8 +150,8 @@ void Velocity::set_dcc_28(uint8_t value)
else
{
velocity = (value & 0x01F) - 3;
velocity *= 128;
velocity /= (28 * MPH_FACTOR);
velocity *= 128 * MPH_FACTOR;
velocity /= 28;
}

if ((value & 0x40) == 0)
Expand All @@ -171,11 +172,12 @@ void Velocity::set_dcc_28(uint8_t value)
uint8_t Velocity::get_dcc_14()
{
uint8_t result;
uint32_t tmp = ((speed() * MPH_FACTOR * 14) / 128) + 0.5;
uint32_t tmp = ((speed() * 14) / (128 * MPH_FACTOR)) + 0.5;

if (tmp == 0)
{
result = 0;
// If input speed is not zero, make actual speed step at least 1.
result = speed() == 0 ? 0 : 2;
}
else if (tmp > 14)
{
Expand Down Expand Up @@ -209,8 +211,8 @@ void Velocity::set_dcc_14(uint8_t value)
else
{
velocity = (value & 0x0F) - 1;
velocity *= 128;
velocity /= (14 * MPH_FACTOR);
velocity *= 128 * MPH_FACTOR;
velocity /= 14;
}

if ((value & 0x20) == 0)
Expand Down
127 changes: 101 additions & 26 deletions src/openlcb/Velocity.cxxtest
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -373,18 +373,18 @@ TEST(NMRAnetVelocityTest, set_get_dcc_128_equivalent)

TEST(NMRAnetVelocityTest, get_dcc_28_forward)
{
Velocity *velocity = new Velocity(100.5F);
Velocity *velocity = new Velocity(53.5F);

EXPECT_EQ(velocity->direction(), Velocity::FORWARD);
EXPECT_TRUE(velocity->get_dcc_28() == (0x40 | 0x16 | 0x20));
EXPECT_EQ((0x40 | 0x1E | 0x20), velocity->get_dcc_28());
}

TEST(NMRAnetVelocityTest, get_dcc_28_reverse)
{
Velocity *velocity = new Velocity(-100.5F);
Velocity *velocity = new Velocity(-53.5F);

EXPECT_EQ(velocity->direction(), Velocity::REVERSE);
EXPECT_TRUE(velocity->get_dcc_28() == (0x40 | 0x16));
EXPECT_EQ((0x40 | 0x1E), velocity->get_dcc_28());
}

TEST(NMRAnetVelocityTest, get_dcc_28_zero)
Expand All @@ -405,22 +405,25 @@ TEST(NMRAnetVelocityTest, get_dcc_28_saturate)

TEST(NMRAnetVelocityTest, set_dcc_28_forward)
{
Velocity *velocity = new Velocity();

velocity->set_dcc_28(0x40 | 0x16 | 0x20);
Velocity velocity;

// Forward step 10.
velocity.set_dcc_28(0x40 | 0x16 | 0x20);

EXPECT_EQ(velocity->direction(), Velocity::FORWARD);
EXPECT_TRUE(*velocity == (10.0F / ((0.44704F * 28.0F)/128.0F)));
EXPECT_EQ(velocity.direction(), Velocity::FORWARD);
EXPECT_NEAR(20.4, velocity.speed(), 0.05);
}

TEST(NMRAnetVelocityTest, set_dcc_28_reverse)
{
Velocity *velocity = new Velocity();

velocity->set_dcc_28(0x40 | 0x16);
Velocity velocity;

// Reverse step 10.
velocity.set_dcc_28(0x40 | 0x16);

EXPECT_EQ(velocity->direction(), Velocity::REVERSE);
EXPECT_TRUE(*velocity == -(10.0F / ((0.44704F * 28.0F)/128.0F)));
EXPECT_EQ(velocity.direction(), Velocity::REVERSE);
EXPECT_NEAR(20.4, velocity.speed(), 0.05);
EXPECT_EQ(0x40U | 0x16U, velocity.get_dcc_28());
}

TEST(NMRAnetVelocityTest, set_dcc_28_forward_estop_I)
Expand All @@ -445,18 +448,18 @@ TEST(NMRAnetVelocityTest, set_dcc_28_forward_stop)

TEST(NMRAnetVelocityTest, get_dcc_14_forward)
{
Velocity *velocity = new Velocity(100.5F);
Velocity *velocity = new Velocity(53.5F);

EXPECT_EQ(velocity->direction(), Velocity::FORWARD);
EXPECT_TRUE(velocity->get_dcc_14() == (0x40 | 0x06 | 0x20));
EXPECT_EQ((0x40 | 0x0E | 0x20), velocity->get_dcc_14());
}

TEST(NMRAnetVelocityTest, get_dcc_14_reverse)
{
Velocity *velocity = new Velocity(-100.5F);
Velocity *velocity = new Velocity(-53.5F);

EXPECT_EQ(velocity->direction(), Velocity::REVERSE);
EXPECT_TRUE(velocity->get_dcc_14() == (0x40 | 0x06));
EXPECT_EQ((0x40 | 0x0E), velocity->get_dcc_14());
}

TEST(NMRAnetVelocityTest, get_dcc_14_zero)
Expand All @@ -477,22 +480,22 @@ TEST(NMRAnetVelocityTest, get_dcc_14_saturate)

TEST(NMRAnetVelocityTest, set_dcc_14_forward)
{
Velocity *velocity = new Velocity();
Velocity velocity;

velocity->set_dcc_14(0x40 | 0x06 | 0x20);
velocity.set_dcc_14(0x40 | 0x06 | 0x20);

EXPECT_EQ(velocity->direction(), Velocity::FORWARD);
EXPECT_TRUE(*velocity == (5.0F / ((0.44704F * 14.0F)/128.0F)));
EXPECT_EQ(velocity.direction(), Velocity::FORWARD);
EXPECT_NEAR(20.4, velocity.speed(), 0.05);
}

TEST(NMRAnetVelocityTest, set_dcc_14_reverse)
{
Velocity *velocity = new Velocity();
Velocity velocity;

velocity->set_dcc_14(0x40 | 0x06);
velocity.set_dcc_14(0x40 | 0x06);

EXPECT_EQ(velocity->direction(), Velocity::REVERSE);
EXPECT_TRUE(*velocity == -(5.0F / ((0.44704F * 14.0F)/128.0F)));
EXPECT_EQ(velocity.direction(), Velocity::REVERSE);
EXPECT_NEAR(20.4, velocity.speed(), 0.05);
}

TEST(NMRAnetVelocityTest, set_dcc_14_forward_estop)
Expand All @@ -515,6 +518,78 @@ TEST(NMRAnetVelocityTest, set_dcc_14_forward_stop)
EXPECT_TRUE(*velocity == 0);
}

TEST(NMRAnetVelecityTest, speed_step_conversions)
{
Velocity velocity;

//
// Set 14, get 28/128
//

// Forward speed step 1, 28SS = 2, 128SS = 9.
velocity.set_dcc_14(0x40 | 0x02);
EXPECT_EQ(0x40U | 0x12U, velocity.get_dcc_28());
EXPECT_EQ(9 + 1, velocity.get_dcc_128());
// Forward speed step 2, 28SS = 4, 128SS = 18.
velocity.set_dcc_14(0x40 | 0x03);
EXPECT_EQ(0x40U | 0x13U, velocity.get_dcc_28());
EXPECT_EQ(18 + 1, velocity.get_dcc_128());
// Forward speed step 14, 28SS = 28, 128SS = 126
velocity.set_dcc_14(0x40 | 0x0F);
EXPECT_EQ(0x40U | 0x1FU, velocity.get_dcc_28());
EXPECT_EQ(126 + 1, velocity.get_dcc_128());
// Forward speed step 7, 28SS = 14, 128SS = 64.
velocity.set_dcc_14(0x40 | 0x08);
EXPECT_EQ(0x40U | 0x18U, velocity.get_dcc_28());
EXPECT_EQ(64 + 1, velocity.get_dcc_128());

//
// Set 28, get 14/128
//

// Forward speed step 1, 14SS = 1, 128SS = 5.
velocity.set_dcc_28(0x40 | 0x02);
EXPECT_EQ(0x40U | 0x02U, velocity.get_dcc_14());
EXPECT_EQ(5 + 1, velocity.get_dcc_128());
// Forward speed step 2, 14SS = 1, 128SS = 9.
velocity.set_dcc_28(0x40 | 0x12);
EXPECT_EQ(0x40U | 0x02U, velocity.get_dcc_14());
EXPECT_EQ(9 + 1, velocity.get_dcc_128());
// Forward speed step 28, 14SS = 15, 128SS = 126
velocity.set_dcc_28(0x40 | 0x1F);
EXPECT_EQ(0x40U | 0x0FU, velocity.get_dcc_14());
EXPECT_EQ(126 + 1, velocity.get_dcc_128());
// Forward speed step 14, 14SS = 7, 128SS = 64.
velocity.set_dcc_28(0x40 | 0x18);
EXPECT_EQ(0x40U | 0x08U, velocity.get_dcc_14());
EXPECT_EQ(64 + 1, velocity.get_dcc_128());

//
// Set 128, get 14/28
//

// Forward speed step 1.
velocity.set_dcc_128(2);
EXPECT_EQ(0x40U | 0x02U, velocity.get_dcc_14());
EXPECT_EQ(0x40U | 0x02U, velocity.get_dcc_28());
// Forward speed step 6, 14SS = 1, 28SS = 1.
velocity.set_dcc_128(7);
EXPECT_EQ(0x40U | 0x02U, velocity.get_dcc_14());
EXPECT_EQ(0x40U | 0x02U, velocity.get_dcc_28());
// Forward speed step 7, 14SS = 1, 28SS = 2.
velocity.set_dcc_128(8);
EXPECT_EQ(0x40U | 0x02U, velocity.get_dcc_14());
EXPECT_EQ(0x40U | 0x12U, velocity.get_dcc_28());
// Forward speed step 126.
velocity.set_dcc_128(127);
EXPECT_EQ(0x40U | 0x0FU, velocity.get_dcc_14());
EXPECT_EQ(0x40U | 0x1FU, velocity.get_dcc_28());
// Forward speed step 63.
velocity.set_dcc_128(63);
EXPECT_EQ(0x40U | 0x08U, velocity.get_dcc_14());
EXPECT_EQ(0x40U | 0x18U, velocity.get_dcc_28());
}

TEST(NMRAnetVelocityTest, operators_value)
{
Velocity velocity = 2;
Expand Down
Loading