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.

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

Added '-padding' option to uartdmx plugin. #1656

Open
wants to merge 8 commits into
base: 0.10
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
13 changes: 12 additions & 1 deletion plugins/uartdmx/UartDmxDevice.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,10 @@ using std::string;

const char UartDmxDevice::K_MALF[] = "-malf";
const char UartDmxDevice::K_BREAK[] = "-break";
const char UartDmxDevice::K_PADDING[] = "-padding";
const unsigned int UartDmxDevice::DEFAULT_BREAK = 100;
const unsigned int UartDmxDevice::DEFAULT_MALF = 100;
const unsigned int UartDmxDevice::DEFAULT_PADDING = 0; // at least 0 slots in frame


UartDmxDevice::UartDmxDevice(AbstractPlugin *owner,
Expand All @@ -57,7 +59,10 @@ UartDmxDevice::UartDmxDevice(AbstractPlugin *owner,
if (!StringToInt(m_preferences->GetValue(DeviceMalfKey()), &m_malft)) {
m_malft = DEFAULT_MALF;
}
m_widget.reset(new UartWidget(path));
if (!StringToInt(m_preferences->GetValue(DevicePaddingKey()), &m_paddingt)) {
m_paddingt = DEFAULT_PADDING;
}
m_widget.reset(new UartWidget(path, m_paddingt));
}

UartDmxDevice::~UartDmxDevice() {
Expand All @@ -77,6 +82,9 @@ string UartDmxDevice::DeviceMalfKey() const {
string UartDmxDevice::DeviceBreakKey() const {
return m_path + K_BREAK;
}
string UartDmxDevice::DevicePaddingKey() const {
return m_path + K_PADDING;
}

/**
* Set the default preferences for this one Device
Expand All @@ -94,6 +102,9 @@ void UartDmxDevice::SetDefaults() {
save |= m_preferences->SetDefaultValue(DeviceMalfKey(),
UIntValidator(8, 1000000),
DEFAULT_MALF);
save |= m_preferences->SetDefaultValue(DevicePaddingKey(),
UIntValidator(0, 512), // 0 to 512 slots in frame
DEFAULT_PADDING);
if (save) {
m_preferences->Save();
}
Expand Down
4 changes: 4 additions & 0 deletions plugins/uartdmx/UartDmxDevice.h
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ class UartDmxDevice : public Device {
// Per device options
std::string DeviceBreakKey() const;
std::string DeviceMalfKey() const;
std::string DevicePaddingKey() const;
void SetDefaults();

std::auto_ptr<UartWidget> m_widget;
Expand All @@ -60,11 +61,14 @@ class UartDmxDevice : public Device {
const std::string m_path;
unsigned int m_breakt;
unsigned int m_malft;
unsigned int m_paddingt;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the t's were timing, e..g break time, mark after last frame time, so this should probably just be m_padding.


static const unsigned int DEFAULT_MALF;
static const char K_MALF[];
static const unsigned int DEFAULT_BREAK;
static const char K_BREAK[];
static const unsigned int DEFAULT_PADDING;
static const char K_PADDING[];

DISALLOW_COPY_AND_ASSIGN(UartDmxDevice);
};
Expand Down
8 changes: 7 additions & 1 deletion plugins/uartdmx/UartWidget.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@
#include "ola/io/IOUtils.h"
#include "ola/Logging.h"
#include "plugins/uartdmx/UartWidget.h"
#include "plugins/uartdmx/UartDmxDevice.h"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think we need this include do we?


namespace ola {
namespace plugin {
Expand All @@ -54,8 +55,9 @@ namespace uartdmx {
using std::string;
using std::vector;

UartWidget::UartWidget(const string& path)
UartWidget::UartWidget(const std::string &path, unsigned int padding)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The std:: isn't needed here as we're using std::string

: m_path(path),
m_padding (padding),
m_fd(NOT_OPEN) {
}

Expand Down Expand Up @@ -122,6 +124,10 @@ bool UartWidget::Write(const ola::DmxBuffer& data) {
buffer[0] = DMX512_START_CODE;

data.Get(buffer + 1, &length);
if (length < m_padding) {
memset ((buffer + 1 + length), 0x00, (m_padding - length) );
length = m_padding;
}

if (write(m_fd, buffer, length + 1) <= 0) {
// TODO(richardash1981): handle errors better as per the test code,
Expand Down
4 changes: 2 additions & 2 deletions plugins/uartdmx/UartWidget.h
Original file line number Diff line number Diff line change
Expand Up @@ -49,8 +49,7 @@ class UartWidget {
* Construct a new UartWidget instance for one widget.
* @param path The device file path of the serial port
*/
explicit UartWidget(const std::string &path);

explicit UartWidget(const std::string &path, unsigned int padding);
/** Destructor */
virtual ~UartWidget();

Expand Down Expand Up @@ -81,6 +80,7 @@ class UartWidget {

private:
const std::string m_path;
unsigned int m_padding;

/**
* variable to hold the Unix file descriptor used to open and manipulate
Expand Down