Motion Master 6.0.0-alpha.86
Next-generation motion control software
Loading...
Searching...
No Matches
somanet_control.h
Go to the documentation of this file.
1#pragma once
2
3#include <chrono>
4#include <cstdint>
5#include <expected>
6#include <string>
7#include <vector>
8
10#include "node/somanet_drive.h"
11
12namespace mm::node {
13
28
35std::expected<BrakeState, std::string> brakeState(DeviceManager& deviceManager,
36 uint16_t slavePosition);
37
52std::expected<BrakeState, std::string> releaseBrake(DeviceManager& deviceManager,
53 uint16_t slavePosition,
54 std::chrono::milliseconds settle);
55
62std::expected<BrakeState, std::string> engageBrake(DeviceManager& deviceManager,
63 uint16_t slavePosition,
64 std::chrono::milliseconds settle);
65
75std::expected<std::vector<DeviceFile>, std::string> readFileList(DeviceManager& deviceManager,
76 uint16_t slavePosition);
77
88std::expected<void, std::string> removeFile(DeviceManager& deviceManager, uint16_t slavePosition,
89 const std::string& filename);
90
99std::expected<HardwareDescription, std::string> readHardwareDescription(
100 DeviceManager& deviceManager, uint16_t slavePosition);
101
112std::expected<std::optional<IntegroVariant>, std::string> readIntegroVariant(
113 DeviceManager& deviceManager, uint16_t slavePosition);
114
124std::expected<FirmwareCompatibility, std::string> checkFirmwarePackage(
125 DeviceManager& deviceManager, uint16_t slavePosition, std::string_view packageFilename);
126
137std::expected<HrdRecording, std::string> readHrdRecording(DeviceManager& deviceManager,
138 uint16_t slavePosition,
139 somanet::HrdData data);
140
141} // namespace mm::node
HrdData
Which signal a high resolution data (HRD) stream records — OS command 3's data index....
Definition somanet_drive.h:577
Definition bus_health_source.h:7
std::expected< HrdRecording, std::string > readHrdRecording(DeviceManager &deviceManager, uint16_t slavePosition, somanet::HrdData data)
Reads a drive's high resolution data recording back and decodes it.
Definition somanet_control.cc:92
std::expected< BrakeState, std::string > brakeState(DeviceManager &deviceManager, uint16_t slavePosition)
Reads a drive's brake configuration and current state (0x2004).
Definition somanet_control.cc:33
std::expected< void, std::string > removeFile(DeviceManager &deviceManager, uint16_t slavePosition, const std::string &filename)
Deletes one file from a device's flash.
Definition somanet_control.cc:59
std::expected< BrakeState, std::string > engageBrake(DeviceManager &deviceManager, uint16_t slavePosition, std::chrono::milliseconds settle)
Engages a drive's brake and waits settle for it to bite.
Definition somanet_control.cc:46
std::expected< std::optional< IntegroVariant >, std::string > readIntegroVariant(DeviceManager &deviceManager, uint16_t slavePosition)
Reads and parses a device's .variant file.
Definition somanet_control.cc:79
std::expected< HardwareDescription, std::string > readHardwareDescription(DeviceManager &deviceManager, uint16_t slavePosition)
Reads and parses a device's .hardware_description file.
Definition somanet_control.cc:73
std::expected< FirmwareCompatibility, std::string > checkFirmwarePackage(DeviceManager &deviceManager, uint16_t slavePosition, std::string_view packageFilename)
Reads what a device is and decides whether a firmware package belongs on it.
Definition somanet_control.cc:85
std::expected< std::vector< DeviceFile >, std::string > readFileList(DeviceManager &deviceManager, uint16_t slavePosition)
Reads the list of files stored on a device (FoE read of "fs-getlist").
Definition somanet_control.cc:53
bool releaseBrake
Definition somanet_procedures.cc:436