N2KTypes.h

Go to the documentation of this file.

/*
 *  Copyright (C) 2023 Swansea University
 *
 *  This file is part of the SELKIELogger suite of tools.
 *
 *  SELKIELogger 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.
 *
 *  SELKIELogger 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 SELKIELogger product.
 *  If not, see <http://www.gnu.org/licenses/>.
*/
 
#ifndef SELKIELoggerN2K_Types
#define SELKIELoggerN2K_Types
 
#include "SELKIELoggerBase.h"
#include <stdbool.h>
#include <stdint.h>
 
/*
 * Logic from CANHandler.cs
 
 * N2kFrame build process
 *
 * Extract Header
 * If fast packet (multipart message):
 *  Check if part of existing sequence in pending list
 *      If end of sequence, assemble data and return
 *      Else, add to pending list and return nothing
 *  Else if valid start of fast packet sequence, add to pending list
 *  Else, discard and return nothing
 * Else
 *  Return Frame
 *
 */
 
/*
 * From CANReader
 * Actisense devices:
 *
 */
 
#define ACT_ESC 0x10 
#define ACT_SOT 0x02 
#define ACT_EOT 0x03 
#define ACT_N2K 0x93 
#define ACT_BEM 0xA0 
 
typedef struct {
    // Header not stored: ACT_ESC ACT_SOT ACT_N2K
    uint8_t length;     
    uint8_t priority;   
    uint32_t PGN;       
    uint8_t dst;        
    uint8_t src;        
    uint32_t timestamp; 
    uint8_t datalen;    
    uint8_t *data;      
    uint8_t csum;
    // Footer not stored (ACT_ESC ACT_EOT)
} n2k_act_message;
 
bool n2k_act_to_bytes(const n2k_act_message *act, uint8_t **out, size_t *len);
 
bool n2k_act_from_bytes(const uint8_t *in, const size_t len, n2k_act_message **msg, size_t *pos, bool debug);
 
uint8_t n2k_act_checksum(const n2k_act_message *msg);
 
void n2k_act_print(const n2k_act_message *msg);
 
#endif