2021-08-07 13:48:00 -04:00
|
|
|
/*
|
|
|
|
dmx.h
|
|
|
|
|
|
|
|
Copyright (c) 2021 Kevin Matz (kevin.matz@gmail.com)
|
|
|
|
|
|
|
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
|
|
of this software and associated documentation files (the "Software"), to deal
|
|
|
|
in the Software without restriction, including without limitation the rights
|
|
|
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
|
|
copies of the Software, and to permit persons to whom the Software is
|
|
|
|
furnished to do so, subject to the following conditions:
|
|
|
|
|
|
|
|
The above copyright notice and this permission notice shall be included in all
|
|
|
|
copies or substantial portions of the Software.
|
|
|
|
|
|
|
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
|
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
|
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
|
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
|
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
|
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
|
|
SOFTWARE.
|
|
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
|
|
|
|
#include <cstdint>
|
|
|
|
|
2022-11-15 11:32:29 -05:00
|
|
|
/**
|
|
|
|
* @brief @cite DMX The Digital Multiplex Protocol
|
|
|
|
*/
|
2021-08-07 13:48:00 -04:00
|
|
|
namespace DMX {
|
2023-04-16 11:05:04 -04:00
|
|
|
/// \cite DMX 1.4 Classes of data appropriate for transmission
|
|
|
|
///
|
|
|
|
/// DMX512 is designed to carry repetitive control data from a single controller
|
|
|
|
/// to one or more receivers.
|
|
|
|
enum DeviceClass
|
|
|
|
{
|
|
|
|
CONTROLLER, //!< 3.7 A transmitting device that originates DMX512 data.
|
|
|
|
RECEIVER, //!< 3.30 A piece of equipment that accepts a DMX512 signal.
|
|
|
|
RESPONDER, //!< 4.3 A RECEIVER capable of returning status information
|
|
|
|
};
|
|
|
|
|
2022-12-06 14:50:20 -05:00
|
|
|
/// \cite DMX Table D1 - Reserved START Codes
|
2021-08-07 13:48:00 -04:00
|
|
|
static const uint8_t E111_NULL_START = 0;
|
|
|
|
static const uint8_t E111_ASC_TEXT_ASCII = 23;
|
|
|
|
static const uint8_t E111_ASC_TEST = 85;
|
|
|
|
static const uint8_t E111_ASC_TEXT_UTF8 = 144;
|
|
|
|
static const uint8_t E111_ASC_MANUFACTURER = 145;
|
|
|
|
static const uint8_t E111_ASC_SIP = 207;
|
|
|
|
|
2022-12-06 14:50:20 -05:00
|
|
|
/// \cite DMX 8.1 Data Protocol: Format
|
|
|
|
///
|
2022-06-04 10:29:00 -04:00
|
|
|
/// DMX512 slots shall be transmitted sequentially in asynchronous serial
|
|
|
|
/// format, beginning with slot 0 and ending with the last implemented slot,
|
|
|
|
/// up to slot 512 (a maximum total of 513 slots).
|
|
|
|
static const std::size_t E111_LAST_SLOT = 512;
|
|
|
|
|
2022-12-06 14:50:20 -05:00
|
|
|
/// \cite DMX 8.5.3.1 Alternate START code refresh interval
|
|
|
|
///
|
2021-08-26 11:54:30 -04:00
|
|
|
/// A DMX512 transmitter interleaving NULL START Code packets with
|
|
|
|
/// Alternate START Code packets shall send a NULL START Code packet at least
|
|
|
|
/// once per second.
|
2021-08-07 13:48:00 -04:00
|
|
|
static const uint16_t E111_DATA_LOSS_TIMEOUT = 1000;
|
|
|
|
} // namespace DMX
|