BaseProtocol.h

/*
 * Copyright (C) 2017 3devo (http://www.3devo.eu)
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#pragma once

#include <stdint.h>
#include "Config.h"

struct Status {
	static const uint8_t COMMAND_OK            = 0x00;
	static const uint8_t COMMAND_FAILED        = 0x01;
	static const uint8_t COMMAND_NOT_SUPPORTED = 0x02;
	static const uint8_t INVALID_TRANSFER      = 0x03;
	static const uint8_t INVALID_CRC           = 0x04;
	static const uint8_t INVALID_ARGUMENTS     = 0x05;
	// Never sent, used internally to indicate no status should be
	// returned.
	static const uint8_t NO_REPLY              = 0xff;
};

struct GeneralCallCommands {
	#if defined(USE_I2C)
		static const uint8_t RESET = 0x06;
		static const uint8_t RESET_ADDRESS = 0x04;
	#elif defined(USE_RS485)
		// These add 0x40 to the I2C general call commands so they en up
		// in the 0x40-0x48 "user defined function codes" area.
		static const uint8_t RESET = 0x46;
		static const uint8_t RESET_ADDRESS = 0x44;
	#endif
};

// Commands typically also supported by application firmware
struct ProtocolCommands {
	static const uint8_t GET_PROTOCOL_VERSION  = 0x00;
	static const uint8_t SET_ADDRESS           = 0x01;
	static const uint8_t GET_MAX_PACKET_LENGTH = 0x0c;
};

struct cmd_result {
	cmd_result(uint8_t status, uint8_t len = 0) : status(status), len(len) {}
	uint8_t status;
	uint8_t len;
};

inline cmd_result cmd_ok(uint8_t len = 0) {
	return cmd_result(Status::COMMAND_OK, len);
}

cmd_result processCommand(uint8_t cmd, uint8_t *datain, uint8_t len, uint8_t *dataout, uint8_t maxLen);
void resetSystem();