examples/master.cpp

This example shows how to use the KaCanOpen Master library. It waits for a device with a specific ID, loads a dictionary from the EDS library and reads and writes various dictionary entries like mandatory and optional CiA-301 entries. If possible, it controls a CiA-402 motor or it handles digital I/Os of a CiA-401 I/O device. Furthermore it shows how to use profile-specific operations and constants.

/*
 * Copyright (c) 2016, Thomas Keh
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *    1. Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *
 *    2. Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *
 *    3. Neither the name of the copyright holder nor the names of its
 *       contributors may be used to endorse or promote products derived from
 *       this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

#include <thread>
#include <chrono>
#include <cstdint>

#include "master.h"
#include "canopen_error.h"
#include "logger.h"

int main() {

    // ----------- //
    // Preferences //
    // ----------- //

    // The node ID of the slave we want to communicate with.
    const uint8_t node_id = 2;

    // Set the name of your CAN bus. "slcan0" is a common bus name
    // for the first SocketCAN device on a Linux system.
    const std::string busname = "slcan0";

    // Set the baudrate of your CAN bus. Most drivers support the values
    // "1M", "500K", "125K", "100K", "50K", "20K", "10K" and "5K".
    const std::string baudrate = "500K";

    // -------------- //
    // Initialization //
    // -------------- //

    std::cout << "This is an example which shows the usage of the Master library." << std::endl;

    // Create Master (includes Core - accessible via master.core).
    kaco::Master master;

    std::cout << "Starting Master (involves starting Core)..." << std::endl;
    if (!master.start(busname, baudrate)) {
        std::cout << "Starting Master failed." << std::endl;
        return EXIT_FAILURE;
    }

    bool found_device = false;
    size_t device_index;

    while (!found_device) {

        for (size_t i=0; i<master.num_devices(); ++i) {
            kaco::Device& device = master.get_device(i);
            if (device.get_node_id()==node_id) {
                found_device = true;
                device_index = i;
                break;
            }
        }

        std::cout << "Device with ID " << (unsigned) node_id
            << " has not been found yet. Waiting one more second. Press Ctrl+C abort." << std::endl;
        std::this_thread::sleep_for(std::chrono::seconds(1));

    }

    // ------------ //
    // Device usage //
    // ------------ //
    
    kaco::Device& device = master.get_device(device_index);

    std::cout << "Starting device with ID " << (unsigned) node_id << "..." << std::endl;
    device.start();

    std::cout << "Loading object dictionary from the library. This can be either a generic CiA-301" 
        << " dictionary, a CiA-profile specific dictionary, or a manufacturer./device-specific dictionary." << std::endl;
    const std::string loaded_eds_file = device.load_dictionary_from_library();
    std::cout << "Loaded the following EDS file from the library: " << loaded_eds_file << std::endl;

    std::cout << "Alternatively, you could load your own EDS file via device.load_dictionary_from_eds(path)." << std::endl;
    // device.load_dictionary_from_eds("...");

    std::cout << "The following should work for all CANopen-compliant devices." << std::endl;

    std::cout << "CiA-profile = " << device.get_device_profile_number() << std::endl;

    std::cout << "Vendor-ID = " << device.get_entry("Identity object/Vendor-ID") << std::endl;

    std::cout << "The following works for most CANopen-compliant devices (however, the entries are not mandatory)." << std::endl;
    try {

        std::cout << "Manufacturer device name = " << device.get_entry("Manufacturer device name") << std::endl;

        std::cout << "Manufacturer hardware version = " << device.get_entry("Manufacturer hardware version") << std::endl;

        std::cout << "Manufacturer software version = " << device.get_entry("Manufacturer software version") << std::endl;

    } catch (const kaco::canopen_error& error) {
        std::cout << "Getting manufacturer information failed: " << error.what() << std::endl;
    }

    std::cout << "The following should fail on devices which are not CiA-402 motors." << std::endl;
    try {
        
        std::cout << "CiA-402: Set position mode using a built-in constant (see master/src/profiles.cpp)..." << std::endl;
        device.set_entry("modes_of_operation", device.get_constant("profile_position_mode"));

        std::cout << "CiA-402: Enable operation using a built-in operation (see master/src/profiles.cpp)..." << std::endl;
        device.execute("enable_operation");

        std::cout << "CiA-402: Set target position..." << std::endl;
        // Type of target position is INT32, so cast accordingly.
        device.execute("set_target_position", (int32_t) 0);

        std::cout << "Waiting a second..." << std::endl;
        std::this_thread::sleep_for(std::chrono::seconds(1));

        std::cout << "CiA-402: Set target position..." << std::endl;
        // Type of target position is INT32, so cast accordingly.
        device.execute("set_target_position", (int32_t) 5000);

        std::cout << "Waiting a second..." << std::endl;
        std::this_thread::sleep_for(std::chrono::seconds(1));

        std::cout << "CiA-402: Set target position..." << std::endl;
        // Type of target position is INT32, so cast accordingly.
        device.execute("set_target_position", (int32_t) 10000);

    } catch (const kaco::canopen_error& error) {
        std::cout << "CiA-402 failed: " << error.what() << std::endl;
    }

    std::cout << "The following should fail on devices which are not CiA-401 I/O devices." << std::endl;
    try {

        std::cout << "CiA-401: Set digital output (first byte)..." << std::endl;
        // Type of this entry is UINT8, so cast accordingly.
        device.set_entry("Write output 8-bit/Digital Outputs 1-8", (uint8_t) 0xEA);

        std::cout << "CiA-401: Get digital input (first byte)..." << std::endl;
        // Correct type casting is also important when reading values.
        std::cout << "First input byte = 0x" << std::hex << (unsigned) ((uint8_t) device.get_entry("Read input 8 bit/Digital Inputs 1-8")) << std::endl;

    } catch (const kaco::canopen_error& error) {
        std::cout << "CiA-401 failed: " << error.what() << std::endl;
    }

}