Skip to content

Add a way to access dmxBuffer #13

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

Open
Tuhis wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add a way to access dmxBuffer #13

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
21 changes: 18 additions & 3 deletions DmxSimple.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ void dmxSendByte(volatile uint8_t value)
"and __tmp_reg__,%[outMask]\n"
"st %a[dmxPort],__tmp_reg__\n"
"ldi %[bitCount],11\n" // 11 bit intervals per transmitted byte
"rjmp bitLoop%=\n" // Delay 2 clock cycles.
"rjmp bitLoop%=\n" // Delay 2 clock cycles.
"bitLoop%=:\n"\
"ldi %[delCount],%[delCountVal]\n"
"delLoop%=:\n"
Expand Down Expand Up @@ -189,7 +189,7 @@ void dmxSendByte(uint8_t value)

/** DmxSimple interrupt routine
* Transmit a chunk of DMX signal every timer overflow event.
*
*
* The full DMX transmission takes too long, but some aspects of DMX timing
* are flexible. This routine chunks the DMX signal, only sending as much as
* it's time budget will allow.
Expand Down Expand Up @@ -231,7 +231,7 @@ ISR(ISR_NAME,ISR_NOBLOCK) {
break;
}
}

// Enable interrupts for the next transmission chunk
TIMER2_INTERRUPT_ENABLE();
}
Expand Down Expand Up @@ -286,4 +286,19 @@ void DmxSimpleClass::write(int address, uint8_t value)
{
dmxWrite(address, value);
}

/** Manually start dmx transmission
*/
void DmxSimpleClass::dmxStart()
{
if (!dmxStarted) dmxBegin();
}

/** Get internally used dmx buffer
*/
uint8_t* DmxSimpleClass::getInternalBuffer()
{
return dmxBuffer;
}

DmxSimpleClass DmxSimple;
2 changes: 2 additions & 0 deletions DmxSimple.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ class DmxSimpleClass
void maxChannel(int);
void write(int, uint8_t);
void usePin(uint8_t);
void dmxStart();
uint8_t* getInternalBuffer();
};
extern DmxSimpleClass DmxSimple;

Expand Down
28 changes: 18 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,41 +10,49 @@ DmxSimple does some fancy stuff behind the scenes, so there is no need to worry

## Compatibility

DmxSimple is compatible with all known Arduinos including the Mega. The following Arduinos are recommended, as they support both DmxSimple and the Tinker.it! DMX shield: Arduino Mega, Arduino Duemilanove 328, Arduino Duemilanove, Arduino Diecimila, Arduino Bluetooth, Arduino Pro (5V version only), Arduino NG, Arduino Serial.
DmxSimple is compatible with all known Arduinos including the Mega. The following Arduinos are recommended, as they support both DmxSimple and the Tinker.it! DMX shield: Arduino Mega, Arduino Duemilanove 328, Arduino Duemilanove, Arduino Diecimila, Arduino Bluetooth, Arduino Pro (5V version only), Arduino NG, Arduino Serial.

## Installation

Download the archive. Extract to (arduino install)/hardware/libraries/DmxSimple . Restart Arduino so it recognises the library.
Download the archive. Extract to (arduino install)/hardware/libraries/DmxSimple . Restart Arduino so it recognises the library.

## Example code

FadeUp
SerialToDmx
SerialToDmx

The example code is also built into the library. Open Arduino, and look under File > Sketchbook > Examples > Library-DmxSimple.
The example code is also built into the library. Open Arduino, and look under File > Sketchbook > Examples > Library-DmxSimple.

## Function calls

### DmxSimple.write(channel, value);

Set DMX channel to value. Channel has the range 1 to 512 (128 on old Arduinos with a 168 or Mega 8). Value is in the range 0 (off) to 255 (full brightness).
Set DMX channel to value. Channel has the range 1 to 512 (128 on old Arduinos with a 168 or Mega 8). Value is in the range 0 (off) to 255 (full brightness).

### DmxSimple.maxChannel(channel);

Set the number of DMX channels in the DMX system. The DMX system sends out channels in order, starting at 1. So it takes longer to send channels 1-512 than it does to send only channels 1-10. DmxSimple defaults to sending all channels, but by reducing this you can increase the lamp update rate for even smoother animation. Using DmxSimple.maxChannel(0) turns off the DMX system, so you can use pin 3 as a regular pin. It will revert to a DMX output next time you call DmxSimple.write() or DmxSimple.maxChannel(nonzero).
Set the number of DMX channels in the DMX system. The DMX system sends out channels in order, starting at 1. So it takes longer to send channels 1-512 than it does to send only channels 1-10. DmxSimple defaults to sending all channels, but by reducing this you can increase the lamp update rate for even smoother animation. Using DmxSimple.maxChannel(0) turns off the DMX system, so you can use pin 3 as a regular pin. It will revert to a DMX output next time you call DmxSimple.write() or DmxSimple.maxChannel(nonzero).

### DmxSimple.usePin(pin);

Set the output pin. DmxSimple defaults to using pin 3, making it compatible with the Tinker.it! DMX shield. But if you use this function, you can output on any pin capable of digital output.
Set the output pin. DmxSimple defaults to using pin 3, making it compatible with the Tinker.it! DMX shield. But if you use this function, you can output on any pin capable of digital output.

### DmxSimple.startDmx();

Manually start dmx transmission. This must be called if the dmxBuffer is updated manually.

### DmxSimple.getInternalBuffer();

Get the internally used DMX channel data buffer. Small performance gains might be gained by directly modifying the buffer.

## DmxSimple community

We now have a group on Google Groups. Get assistance starting with DMX, or show off your installations.
We now have a group on Google Groups. Get assistance starting with DMX, or show off your installations.

## Library limitations

Timer 2 is used. Due to the small amount of RAM on 168 and Mega8 Arduinos, only the first 128 channels are supported. Arduinos with processor sockets can easily be upgraded to a 328 to control all 512 channels.
Timer 2 is used. Due to the small amount of RAM on 168 and Mega8 Arduinos, only the first 128 channels are supported. Arduinos with processor sockets can easily be upgraded to a 328 to control all 512 channels.

## Upgrade notes

The original version 1 of DmxSimple used a file "DmxInterrupt.h". This has since been removed. To upgrade old sketches, remove the #include "DmxInterrupt.h" line. When upgrading the library from v1, delete all the old files before copying the contents of the new archive.
The original version 1 of DmxSimple used a file "DmxInterrupt.h". This has since been removed. To upgrade old sketches, remove the #include "DmxInterrupt.h" line. When upgrading the library from v1, delete all the old files before copying the contents of the new archive.
4 changes: 3 additions & 1 deletion keywords.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,9 @@ DmxSimple KEYWORD1
write KEYWORD2
maxChannel KEYWORD2
usePin KEYWORD2

dmxStart KEYWORD2
getInternalBuffer KEYWORD2

#######################################
# Constants (LITERAL1)
#######################################
Expand Down