packet.h File Reference

#include <stdint.h>

Go to the source code of this file.

Classes
struct	DCCPacket
	Stores a DCC packet in memory. More...
struct	DCCPacket::pkt_t
	Specifies the meaning of the command byte for packets to send. More...
struct	DCCPacket::cmd_t
	Specifies the meaning of the command byte for meta-commands to send. More...

Macros
#define	DCC_PACKET_MAX_PAYLOAD   (32)
	Maximum number of payload bytes.
#define	DCC_PACKET_EMERGENCY_STOP   (0xFFFF)
	Send this speed step to emergency-stop the locomotive.
#define	DCC_PACKET_CHANGE_DIR   (0xFFFF)
	Send this speed step to switch direction of the locomotive.

Detailed Description

Copyright

Copyright (c) 2016, Balazs Racz All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

• Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
• Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Defines a DCC Packet structure.

Author

Balazs Racz

Date

5 February 2016

Definition in file packet.h.

Macro Definition Documentation

DCC_PACKET_CHANGE_DIR

#define DCC_PACKET_CHANGE_DIR   (0xFFFF)

Send this speed step to switch direction of the locomotive.

Only used for marklin-14-step speed commands.

Definition at line 50 of file packet.h.

DCC_PACKET_EMERGENCY_STOP

#define DCC_PACKET_EMERGENCY_STOP   (0xFFFF)

Send this speed step to emergency-stop the locomotive.

Definition at line 47 of file packet.h.

DCC_PACKET_MAX_PAYLOAD

#define DCC_PACKET_MAX_PAYLOAD   (32)

Maximum number of payload bytes.

Definition at line 45 of file packet.h.