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         std::vector<uint8_t>& data,
  49         uint64_t timestamp,
  50         name_t name,
  51         pgn_t pgn,
  52         uint8_t addr):
  53         message_t(J1939_MAX_DLEN, length, J1939_PROTOCOL, data, timestamp),
  54         name_{name},
  55         pgn_{pgn},
  56         addr_{addr}
  57 {}
  58
  59 ///
  60 /// @brief Retrieve name_ member value.
  61 ///
  62 /// @return name_ class member
  63 ///
  64 uint64_t j1939_message_t::get_name() const {
  65         return name_;
  66 }
  67
  68 ///
  69 /// @brief Retrieve pgn_ member value.
  70 ///
  71 /// @return pgn_ class member
  72 ///
  73 uint32_t j1939_message_t::get_pgn() const{
  74         return pgn_;
  75 }
  76
  77 ///
  78 /// @brief Retrieve addr_ member value.
  79 ///
  80 /// @return addr_ class member
  81 ///
  82 uint8_t j1939_message_t::get_addr() const{
  83         return addr_;
  84 }
  85
  86
  87 /// @brief Take a sockaddr_can struct and array of data to initialize class members
  88 ///
  89 /// This is the preferred way to initialize class members.
  90 ///
  91 /// @param[in] addr - sockaddr_can to get pgn, name and addr
  92 /// @param[in] data - array of data get from the j1939 socket
  93 /// @param[in] nbytes - size of the array of data
  94 /// @param[in] timestamp - timestamp of the message
  95 ///
  96 /// @return A j1939_message_t object fully initialized with sockaddr_can and data values.
  97 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)
  98 {
  99         int i;
 100         uint32_t length = 0;
 101         std::vector<uint8_t> data_vector;
 102
 103         if(nbytes > J1939_MAX_DLEN)
 104         {
 105                 AFB_DEBUG("Unsupported j1939 frame");
 106                 return std::make_shared<j1939_message_t>(j1939_message_t());
 107         }
 108
 109         length = (uint32_t) nbytes;
 110         data_vector.reserve(length);
 111
 112         data_vector.clear();
 113
 114         std::string data_string;
 115         data_string = converter_t::to_hex(data, length);
 116
 117         for(i=0;i<length;i++)
 118         {
 119                 data_vector.push_back(data[i]);
 120         };
 121
 122         AFB_DEBUG("Found pgn: %X, length: %X, data %s",
 123                                                         addr.can_addr.j1939.pgn, length, data_string.c_str());
 124
 125         return std::make_shared<j1939_message_t>(j1939_message_t(length, data_vector, timestamp, addr.can_addr.j1939.name, addr.can_addr.j1939.pgn, addr.can_addr.j1939.addr));
 126 }
 127
 128 /// @brief Test if members pgn_ and length are set.
 129 ///
 130 /// @return boolean - true = set - false = not set
 131 bool j1939_message_t::is_set()
 132 {
 133         return (pgn_ != 0 && length_ != 0);
 134 }
 135
 136 /// @brief Generate a string with informations about the message
 137 ///
 138 /// @return Debug message with informations about members
 139 std::string j1939_message_t::get_debug_message()
 140 {
 141         std::string ret = "";
 142         ret = ret + "Here is the next j1939 message : pgn " + std::to_string(pgn_)  + " length " + std::to_string(length_) + ", data ";
 143         for (size_t i = 0; i < data_.size(); i++)
 144         {
 145                 ret = ret + std::to_string(data_[i]);
 146         }
 147         return ret;
 148 }
 149
 150 ///
 151 /// @brief Retrieve pgn_ member value.
 152 ///
 153 /// @return pgn_ class member
 154 ///
 155 uint32_t j1939_message_t::get_id() const
 156 {
 157         AFB_DEBUG("Prefer method get_pgn() for j1939 messages");
 158         return get_pgn();
 159 }
 160
 161 void j1939_message_t::set_id(const canid_t id)
 162 {
 163         pgn_ = id;
 164 }
 165
 166
 167 /**
 168  * @brief Return the sockname of the message
 169  *
 170  * @return struct sockaddr_can The sockname of the message
 171  */
 172 struct sockaddr_can j1939_message_t::get_sockname()
 173 {
 174         return sockname_;
 175 }
 176
 177 /**
 178  * @brief Allows to set a sockname at a message to send it after
 179  *
 180  * @param sockname The sockname of the message
 181  */
 182 void j1939_message_t::set_sockname(struct sockaddr_can sockname)
 183 {
 184         sockname_ = sockname;
 185 }
 186
 187 /**
 188  * @brief Allows to generate a sockname for the message
 189  *
 190  * @param pgn The pgn for the sockname
 191  * @param name The name for the sockname
 192  * @param addr The address for the sockname
 193  */
 194 void j1939_message_t::set_sockname(pgn_t pgn, name_t name, uint8_t addr)
 195 {
 196         memset(&sockname_, 0, sizeof(sockname_));
 197         sockname_.can_family = AF_CAN;
 198         sockname_.can_ifindex = 0;
 199
 200         if(addr <= 0 || addr >= UINT8_MAX )
 201         {
 202                 sockname_.can_addr.j1939.addr = J1939_NO_ADDR;
 203         }
 204         else
 205         {
 206                 sockname_.can_addr.j1939.addr = addr;
 207         }
 208
 209         if(name <= 0 || name >= UINT64_MAX )
 210         {
 211                 sockname_.can_addr.j1939.name = J1939_NO_NAME;
 212         }
 213         else
 214         {
 215                 sockname_.can_addr.j1939.name = name;
 216         }
 217
 218         if(pgn <= 0 || pgn > J1939_PGN_MAX)
 219         {
 220                 sockname_.can_addr.j1939.pgn = J1939_NO_PGN;
 221         }
 222         else
 223         {
 224                 sockname_.can_addr.j1939.pgn = pgn;
 225         }
 226 }