low-can-binding/can/message/j1939-message.cpp

   1 /*
   2  * Copyright (C) 2018, 2019 "IoT.bzh"
   3  * Author "Arthur Guyader" <arthur.guyader@iot.bzh>
   4  *
   5  * Licensed under the Apache License, Version 2.0 (the "License");
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at
   8  *
   9  *       http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  */
  17
  18 #include <cstring>
  19 #include <iomanip>
  20 #include <net/if.h>
  21 #include "../../binding/low-can-hat.hpp"
  22 #include "../../utils/converter.hpp"
  23 #include "j1939-message.hpp"
  24
  25 /**
  26  * @brief Construct a new j1939 message t::j1939 message t object
  27  *
  28  */
  29 j1939_message_t::j1939_message_t():
  30         message_t(),
  31         name_{0},
  32         pgn_{0},
  33         addr_{0}
  34 {}
  35
  36 /**
  37  * @brief Construct a new j1939 message t::j1939 message t object
  38  *
  39  * @param length The length of the message
  40  * @param format The format of the message
  41  * @param data The vector data of the message
  42  * @param timestamp The timetamp of the message
  43  * @param name The name of the message
  44  * @param pgn The PGN of the message
  45  * @param addr The address of the message
  46  */
  47 j1939_message_t::j1939_message_t(uint32_t length,
  48         message_format_t format,
  49         std::vector<uint8_t>& data,
  50         uint64_t timestamp,
  51         name_t name,
  52         pgn_t pgn,
  53         uint8_t addr):
  54         message_t(J1939_MAX_DLEN,length, format, data, timestamp, 0),
  55         name_{name},
  56         pgn_{pgn},
  57         addr_{addr}
  58 {}
  59
  60 ///
  61 /// @brief Retrieve name_ member value.
  62 ///
  63 /// @return name_ class member
  64 ///
  65 uint64_t j1939_message_t::get_name() const {
  66         return name_;
  67 }
  68
  69 ///
  70 /// @brief Retrieve pgn_ member value.
  71 ///
  72 /// @return pgn_ class member
  73 ///
  74 uint32_t j1939_message_t::get_pgn() const{
  75         return pgn_;
  76 }
  77
  78 ///
  79 /// @brief Retrieve addr_ member value.
  80 ///
  81 /// @return addr_ class member
  82 ///
  83 uint8_t j1939_message_t::get_addr() const{
  84         return addr_;
  85 }
  86
  87
  88 /// @brief Take a sockaddr_can struct and array of data to initialize class members
  89 ///
  90 /// This is the preferred way to initialize class members.
  91 ///
  92 /// @param[in] addr - sockaddr_can to get pgn, name and addr
  93 /// @param[in] data - array of data get from the j1939 socket
  94 /// @param[in] nbytes - size of the array of data
  95 /// @param[in] timestamp - timestamp of the message
  96 ///
  97 /// @return A j1939_message_t object fully initialized with sockaddr_can and data values.
  98 std::shared_ptr<j1939_message_t> j1939_message_t::convert_from_addr(struct sockaddr_can& addr, uint8_t (&data)[128],size_t nbytes, uint64_t timestamp)
  99 {
 100         int i;
 101         uint32_t length = 0;
 102         message_format_t format;
 103         std::vector<uint8_t> data_vector;
 104
 105         if(nbytes > J1939_MAX_DLEN)
 106         {
 107                 AFB_DEBUG("Unsupported j1939 frame");
 108                 format = message_format_t::INVALID;
 109         }
 110         else
 111         {
 112                 //AFB_DEBUG("Got a j1939 frame");
 113                 format = message_format_t::J1939;
 114         }
 115
 116         length = (uint32_t) nbytes;
 117         data_vector.reserve(length);
 118
 119         data_vector.clear();
 120
 121         std::string data_string;
 122         data_string = converter_t::to_hex(data,length);
 123
 124         for(i=0;i<length;i++)
 125         {
 126                 data_vector.push_back(data[i]);
 127         };
 128
 129         AFB_DEBUG("Found pgn: %X, format: %X, length: %X, data %s",
 130                                                         addr.can_addr.j1939.pgn, (uint8_t)format, length, data_string.c_str());
 131
 132         return std::make_shared<j1939_message_t>(j1939_message_t(J1939_MAX_DLEN,length, format, data_vector, timestamp,addr.can_addr.j1939.name,addr.can_addr.j1939.pgn,addr.can_addr.j1939.addr));
 133 }
 134
 135 /// @brief Test if members pgn_ and length are set.
 136 ///
 137 /// @return boolean - true = set - false = not set
 138 bool j1939_message_t::is_set()
 139 {
 140         return (pgn_ != 0 && length_ != 0);
 141 }
 142
 143 /// @brief Generate a string with informations about the message
 144 ///
 145 /// @return Debug message with informations about members
 146 std::string j1939_message_t::get_debug_message()
 147 {
 148         std::string ret = "";
 149         ret = ret + "Here is the next j1939 message : pgn " + std::to_string(pgn_)  + " length " + std::to_string(length_) + ", data ";
 150         for (size_t i = 0; i < data_.size(); i++)
 151         {
 152                 ret = ret + std::to_string(data_[i]);
 153         }
 154         return ret;
 155 }
 156
 157 ///
 158 /// @brief Retrieve pgn_ member value.
 159 ///
 160 /// @return pgn_ class member
 161 ///
 162 uint32_t j1939_message_t::get_id() const
 163 {
 164         AFB_DEBUG("Prefer method get_pgn() for j1939 messages");
 165         return get_pgn();
 166 }
 167
 168 /**
 169  * @brief Return the sockname of the message
 170  *
 171  * @return struct sockaddr_can The sockname of the message
 172  */
 173 struct sockaddr_can j1939_message_t::get_sockname()
 174 {
 175         return sockname_;
 176 }
 177
 178 /**
 179  * @brief Allows to set a sockname at a message to send it after
 180  *
 181  * @param sockname The sockname of the message
 182  */
 183 void j1939_message_t::set_sockname(struct sockaddr_can sockname)
 184 {
 185         sockname_ = sockname;
 186 }
 187
 188 /**
 189  * @brief Allows to generate a sockname for the message
 190  *
 191  * @param pgn The pgn for the sockname
 192  * @param name The name for the sockname
 193  * @param addr The address for the sockname
 194  */
 195 void j1939_message_t::set_sockname(pgn_t pgn, name_t name, uint8_t addr)
 196 {
 197         memset(&sockname_, 0, sizeof(sockname_));
 198         sockname_.can_family = AF_CAN;
 199         sockname_.can_ifindex = 0;
 200
 201         if(addr <= 0 || addr >= UINT8_MAX )
 202         {
 203                 sockname_.can_addr.j1939.addr = J1939_NO_ADDR;
 204         }
 205         else
 206         {
 207                 sockname_.can_addr.j1939.addr = addr;
 208         }
 209
 210         if(name <= 0 || name >= UINT64_MAX )
 211         {
 212                 sockname_.can_addr.j1939.name = J1939_NO_NAME;
 213         }
 214         else
 215         {
 216                 sockname_.can_addr.j1939.name = name;
 217         }
 218
 219         if(pgn <= 0 || pgn > J1939_PGN_MAX)
 220         {
 221                 sockname_.can_addr.j1939.pgn = J1939_NO_PGN;
 222         }
 223         else
 224         {
 225                 sockname_.can_addr.j1939.pgn = pgn;
 226         }
 227 }