KaCanOpen
 All Classes Functions Variables Typedefs Enumerations Pages
pdo.h
1 /*
2  * Copyright (c) 2015, Thomas Keh
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions are met:
7  *
8  * 1. Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  *
11  * 2. Redistributions in binary form must reproduce the above copyright
12  * notice, this list of conditions and the following disclaimer in the
13  * documentation and/or other materials provided with the distribution.
14  *
15  * 3. Neither the name of the copyright holder nor the names of its
16  * contributors may be used to endorse or promote products derived from
17  * this software without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
20  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
23  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29  * POSSIBILITY OF SUCH DAMAGE.
30  */
31 
32 #pragma once
33 
34 #include <vector>
35 #include <cstdint>
36 #include <functional>
37 #include <mutex>
38 
39 #include "message.h"
40 
41 namespace kaco {
42 
43  // forward declaration
44  class Core;
45 
51  class PDO {
52 
53  public:
54 
60 
62  using Callback = std::function< void(std::vector<uint8_t>) >;
63 
65  uint16_t cob_id;
66 
69 
70  };
71 
74  PDO(Core& core);
75 
77  PDO(const PDO&) = delete;
78 
83  void process_incoming_message(const Message& message) const;
84 
89  void send(uint16_t cob_id, const std::vector<uint8_t>& data);
90 
96  void add_pdo_received_callback(uint16_t cob_id, PDOReceivedCallback::Callback callback);
97 
98  private:
99 
100  static const bool debug = false;
101  Core& m_core;
102 
103  std::vector<PDOReceivedCallback> m_receive_callbacks;
104  mutable std::mutex m_receive_callbacks_mutex;
105 
106  };
107 
108 } // end namespace kaco
This class implements the CanOpen PDO protocol.
Definition: pdo.h:51
void send(uint16_t cob_id, const std::vector< uint8_t > &data)
Sends a PDO message.
Definition: pdo.cpp:83
std::function< void(std::vector< uint8_t >) > Callback
Type of the callback.
Definition: pdo.h:62
uint16_t cob_id
The COB-ID of the PDO to receive.
Definition: pdo.h:65
This class implements the Core of KaCanOpen It communicates with the CAN driver, sends CAN messages a...
Definition: core.h:59
void process_incoming_message(const Message &message) const
Handler for an incoming PDO message.
Definition: pdo.cpp:45
void add_pdo_received_callback(uint16_t cob_id, PDOReceivedCallback::Callback callback)
Adds a callback which will be called when a PDO has been received with the given COB-ID.
Definition: pdo.cpp:102
PDO(Core &core)
Constructor.
Definition: pdo.cpp:41
A PDO message receiver function together with it's COB-ID Important: Never call add_pdo_received_call...
Definition: pdo.h:59
This struct represents a CANOpen message.
Definition: message.h:39
Callback callback
The callback.
Definition: pdo.h:68