sii.h

Go to the documentation of this file.

#pragma once
 
#include <cstdint>
#include <expected>
#include <nlohmann/json.hpp>
#include <optional>
#include <span>
#include <string>
#include <vector>
 
namespace mm::comm {
 
 
struct SiiInfo {
  uint16_t pdiControl = 0;
  uint16_t pdiConfiguration = 0;
  uint16_t syncImpulseLen = 0;
  uint16_t pdiConfiguration2 = 0;
  uint16_t configuredStationAlias = 0;
  uint16_t checksum = 0;
  uint32_t vendorId = 0;
  uint32_t productCode = 0;
  uint32_t revisionNumber = 0;
  uint32_t serialNumber = 0;
  uint16_t bootstrapReceiveMailboxOffset = 0;
  uint16_t bootstrapReceiveMailboxSize = 0;
  uint16_t bootstrapSendMailboxOffset = 0;
  uint16_t bootstrapSendMailboxSize = 0;
  uint16_t standardReceiveMailboxOffset = 0;
  uint16_t standardReceiveMailboxSize = 0;
  uint16_t standardSendMailboxOffset = 0;
  uint16_t standardSendMailboxSize = 0;
  uint16_t mailboxProtocol = 0;
  uint16_t size = 0;
  uint16_t version = 0;
};
 
struct SiiCategoryGeneral {
  uint8_t groupIdx = 0;                
  uint8_t imgIdx = 0;                  
  uint8_t orderIdx = 0;                
  uint8_t nameIdx = 0;                 
  uint8_t coeDetails = 0;              
  uint8_t foeDetails = 0;              
  uint8_t eoeDetails = 0;              
  uint8_t soeChannels = 0;             
  uint8_t ds402Channels = 0;           
  uint8_t sysmanClass = 0;             
  uint8_t flags = 0;                   
  int16_t currentOnEBus = 0;           
  uint16_t physicalPort = 0;           
  uint16_t physicalMemoryAddress = 0;  
};
 
struct SiiCategorySyncManagerElement {
  uint16_t physicalStartAddress = 0;  
  uint16_t length = 0;                
  uint8_t controlRegister = 0;        
  uint8_t statusRegister = 0;         
  uint8_t enableSyncManager = 0;      
  uint8_t syncManagerType = 0;        
};
 
struct SiiCategoryPdoEntryElement {
  uint16_t entryIndex = 0;   
  uint8_t subindex = 0;      
  uint8_t entryNameIdx = 0;  
  uint8_t dataType = 0;      
  uint8_t bitLen = 0;        
  uint16_t flags = 0;        
};
 
struct SiiCategoryPdoElement {
  uint16_t pdoIndex = 0;                            
  uint8_t nEntry = 0;                               
  uint8_t syncM = 0;                                
  uint8_t synchronization = 0;                      
  uint8_t nameIdx = 0;                              
  uint16_t flags = 0;                               
  std::vector<SiiCategoryPdoEntryElement> entries;  
};
 
struct SiiCategoryDistributedClockElement {
  uint32_t cycleTime0 = 0;       
  uint32_t shiftTime0 = 0;       
  uint32_t shiftTime1 = 0;       
  int16_t sync1CycleFactor = 0;  
  uint16_t assignActivate = 0;   
  int16_t sync0CycleFactor = 0;  
  uint8_t nameIdx = 0;           
  uint8_t descIdx = 0;           
};
 
struct SiiCategorySection {
  std::vector<std::string> strings;                         
  SiiCategoryGeneral general;                               
  std::vector<uint8_t> fmmus;                               
  std::vector<SiiCategorySyncManagerElement> syncManagers;  
  std::vector<SiiCategoryPdoElement> rxPdos;                
  std::vector<SiiCategoryPdoElement> txPdos;                
  std::vector<SiiCategoryDistributedClockElement> distributedClocks;  
};
 
struct SlaveInformationInterface {
  SiiInfo info;
  SiiCategorySection category;
};
 
enum class SiiCategoryType : uint16_t {
  Nop = 0,
  DeviceSpecific = 1,
  Strings = 10,
  DataTypes = 20,
  General = 30,
  Fmmu = 40,
  SyncM = 41,
  FmmuX = 42,
  SyncUnit = 43,
  TxPdo = 50,
  RxPdo = 51,
  Dc = 60,
  Timeouts = 70,
  Dictionary = 80,
  Hardware = 90,
  VendorInformation = 100,
  Images = 110,
  VendorSpecific = 0x0800,
  ApplicationSpecific = 0x2000,
  End = 0xFFFF,
};
 
std::optional<SiiCategoryType> resolveSiiCategoryType(uint16_t value);
 
std::expected<SlaveInformationInterface, std::string> parseSii(std::span<const uint8_t> buffer);
 
void to_json(nlohmann::json& j, const SiiInfo& v);
void to_json(nlohmann::json& j, const SiiCategoryGeneral& v);
void to_json(nlohmann::json& j, const SiiCategorySyncManagerElement& v);
void to_json(nlohmann::json& j, const SiiCategoryPdoEntryElement& v);
void to_json(nlohmann::json& j, const SiiCategoryPdoElement& v);
void to_json(nlohmann::json& j, const SiiCategoryDistributedClockElement& v);
void to_json(nlohmann::json& j, const SiiCategorySection& v);
void to_json(nlohmann::json& j, const SlaveInformationInterface& v);
 
}  // namespace mm::comm