Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

od

package

Go to main page

Versions in this module

v1

v1.3.0

Oct 8, 2024

Changes in this version

+ const AreaCommunicationProfileEnd

+ const AreaCommunicationProfileStart

+ const AreaDeviceProfileEnd

+ const AreaDeviceProfileStart

+ const AreaFutureUseEnd

+ const AreaFutureUseStart

+ const AreaInterfaceProfileEnd

+ const AreaInterfaceProfileStart

+ const AreaManufacturerSpecificProfileEnd

+ const AreaManufacturerSpecificProfileStart

+ const EntrySDOClientParameter

+ const EntrySDOServerParameter

+ const FormatEDSAscii

+ const FormatEDSZipped

+ const ObjectTypeARRAY

+ const ObjectTypeDOMAIN

+ const ObjectTypeRECORD

+ const ObjectTypeVAR

+ var ErrEdsFormat = errors.New("invalid EDS format")

+ var ErrorDescriptionMap = map[ODR]string

+ func DecodeAttribute(attribute uint8) string

+ func DecodeToString(data []byte, dataType uint8, base int) (v string, e error)

+ func DecodeToType(data []byte, dataType uint8) (v any, e error)

+ func EncodeAttribute(accessType string, pdoMapping bool, dataType uint8) uint8

+ func ExportEDS(odict *ObjectDictionary, defaultValues bool, filename string) error

+ type EDSFormatHandler func(nodeId uint8, formatType uint8, reader io.Reader) (*ObjectDictionary, error)

type Entry

+ func (entry *Entry) PutRawData(subindex uint8, data []byte) error

+ func (entry *Entry) ReadExactly(subIndex uint8, b []byte, origin bool) error

+ func (entry *Entry) WriteExactly(subIndex uint8, b []byte, origin bool) error

type ObjectDictionary

+ func DefaultEDSFormatHandler(nodeId uint8, formatType uint8, reader io.Reader) (*ObjectDictionary, error)

+ func (od *ObjectDictionary) Entries() map[uint16]*Entry

v1.2.0

Jul 4, 2024

Changes in this version

+ const AttributeMb

+ const AttributeRpdo

+ const AttributeRsrdo

+ const AttributeSdoR

+ const AttributeSdoRw

+ const AttributeSdoW

+ const AttributeStr

+ const AttributeTpdo

+ const AttributeTrpdo

+ const AttributeTrsrdo

+ const AttributeTsrdo

+ const BOOLEAN

+ const DOMAIN

+ const EntryCobIdEMCY

+ const EntryCobIdSYNC

+ const EntryCobIdTIME

+ const EntryCommunicationCyclePeriod

+ const EntryConsumerHeartbeatTime

+ const EntryDeviceType

+ const EntryErrorRegister

+ const EntryHighResTimestamp

+ const EntryIdentityObject

+ const EntryInhibitTimeEMCY

+ const EntryManufacturerDeviceName

+ const EntryManufacturerHardwareVersion

+ const EntryManufacturerSoftwareVersion

+ const EntryManufacturerStatusRegister

+ const EntryProducerHeartbeatTime

+ const EntryRPDOCommunicationEnd

+ const EntryRPDOCommunicationStart

+ const EntryRPDOMappingEnd

+ const EntryRPDOMappingStart

+ const EntryRestoreDefaultParameters

+ const EntryStorageFormat

+ const EntryStoreEDS

+ const EntryStoreParameters

+ const EntrySynchronousCounterOverflow

+ const EntrySynchronousWindowLength

+ const EntryTPDOCommunicationEnd

+ const EntryTPDOCommunicationStart

+ const EntryTPDOMappingEnd

+ const EntryTPDOMappingStart

+ const FlagsPdoSize

+ const INTEGER16

+ const INTEGER32

+ const INTEGER64

+ const INTEGER8

+ const MaxMappedEntriesPdo

+ const OBJ_ARR

+ const OBJ_DOMAIN

+ const OBJ_RECORD

+ const OBJ_VAR

+ const OCTET_STRING

+ const ODT_ARR

+ const ODT_REC

+ const ODT_TYPE_MASK

+ const ODT_VAR

+ const REAL32

+ const REAL64

+ const UNICODE_STRING

+ const UNSIGNED16

+ const UNSIGNED32

+ const UNSIGNED64

+ const UNSIGNED8

+ const VISIBLE_STRING

+ var OBJ_NAME_MAP = map[byte]string

+ func CalculateAttribute(accessType string, pdoMapping bool, dataType uint8) uint8

+ func CheckSize(length int, dataType uint8) error

+ func Decode(data []byte, dataType uint8) (v any, e error)

+ func EncodeFromGeneric(data any) ([]byte, error)

+ func EncodeFromString(variable string, datatype uint8, nodeId uint8) ([]byte, error)

+ func ReadEntryDefault(stream *Stream, data []byte, countRead *uint16) error

+ func ReadEntryDisabled(stream *Stream, data []byte, countRead *uint16) error

+ func ReadEntryFileObject(stream *Stream, data []byte, countRead *uint16) error

+ func ReadEntryReader(stream *Stream, data []byte, countRead *uint16) error

+ func WriteEntryDefault(stream *Stream, data []byte, countWritten *uint16) error

+ func WriteEntryDisabled(stream *Stream, data []byte, countWritten *uint16) error

+ func WriteEntryFileObject(stream *Stream, data []byte, countWritten *uint16) error

+ type Entry struct

+ Index uint16

+ Name string

+ ObjectType uint8

+ func (entry *Entry) AddExtension(object any, read StreamReader, write StreamWriter)

+ func (entry *Entry) Extension() *extension

+ func (entry *Entry) FlagPDOByte(subIndex byte) *uint8

+ func (entry *Entry) GetRawData(subIndex uint8, length uint16) ([]byte, error)

+ func (entry *Entry) PutUint16(subIndex uint8, data uint16, origin bool) error

+ func (entry *Entry) PutUint32(subIndex uint8, data uint32, origin bool) error

+ func (entry *Entry) PutUint64(subIndex uint8, data uint64, origin bool) error

+ func (entry *Entry) PutUint8(subIndex uint8, value uint8, origin bool) error

+ func (entry *Entry) SubCount() int

+ func (entry *Entry) SubIndex(subIndex any) (v *Variable, e error)

+ func (entry *Entry) Uint16(subIndex uint8) (uint16, error)

+ func (entry *Entry) Uint32(subIndex uint8) (uint32, error)

+ func (entry *Entry) Uint64(subIndex uint8) (uint64, error)

+ func (entry *Entry) Uint8(subIndex uint8) (uint8, error)

+ type FileObject struct

+ File *os.File

+ FilePath string

+ ReadMode int

+ WriteMode int

+ type ODR int8

+ const ErrCount

+ const ErrDataDevState

+ const ErrDataLocCtrl

+ const ErrDataLong

+ const ErrDataShort

+ const ErrDataTransf

+ const ErrDevIncompat

+ const ErrGeneral

+ const ErrHw

+ const ErrIdxNotExist

+ const ErrInvalidValue

+ const ErrMapLen

+ const ErrMaxLessMin

+ const ErrNo

+ const ErrNoData

+ const ErrNoMap

+ const ErrNoRessource

+ const ErrOdMissing

+ const ErrOutOfMem

+ const ErrParIncompat

+ const ErrPartial

+ const ErrReadonly

+ const ErrSubNotExist

+ const ErrTypeMismatch

+ const ErrUnsuppAccess

+ const ErrValueHigh

+ const ErrValueLow

+ const ErrWriteOnly

+ func (odr ODR) Error() string

+ type ObjectDictionary struct

+ Reader io.ReadSeeker

+ func Default() *ObjectDictionary

+ func NewOD() *ObjectDictionary

+ func Parse(file any, nodeId uint8) (*ObjectDictionary, error)

+ func (od *ObjectDictionary) AddFile(index uint16, indexName string, filePath string, readMode int, writeMode int)

+ func (od *ObjectDictionary) AddRPDO(rpdoNb uint16) error

+ func (od *ObjectDictionary) AddReader(index uint16, indexName string, reader io.Reader)

+ func (od *ObjectDictionary) AddSYNC()

+ func (od *ObjectDictionary) AddTPDO(tpdoNb uint16) error

+ func (od *ObjectDictionary) AddVariableList(index uint16, name string, varList *VariableList) *Entry

+ func (od *ObjectDictionary) AddVariableType(index uint16, name string, datatype uint8, attribute uint8, value string) (*Entry, error)

+ func (od *ObjectDictionary) Index(index any) *Entry

+ type Stream struct

+ Attribute uint8

+ Data []byte

+ DataLength uint32

+ DataOffset uint32

+ Object any

+ Subindex uint8

+ type StreamReader func(stream *Stream, read []byte, countRead *uint16) error

+ type StreamWriter func(stream *Stream, to_write []byte, countWritten *uint16) error

+ type Streamer struct

+ func NewStreamer(entry *Entry, subIndex uint8, origin bool) (*Streamer, error)

+ func (s *Streamer) HasAttribute(attribute uint8) bool

+ func (s *Streamer) Read(b []byte) (n int, err error)

+ func (s *Streamer) Reader() StreamReader

+ func (s *Streamer) ResetData(size uint32, offset uint32)

+ func (s *Streamer) SetReader(reader StreamReader)

+ func (s *Streamer) SetStream(stream Stream)

+ func (s *Streamer) SetWriter(writer StreamWriter)

+ func (s *Streamer) Write(b []byte) (n int, err error)

+ func (s *Streamer) Writer() StreamWriter

+ type Variable struct

+ Attribute uint8

+ DataType byte

+ HighLimit int

+ LowLimit int

+ Name string

+ StorageLocation string

+ SubIndex uint8

+ func NewVariable(subindex uint8, name string, datatype uint8, attribute uint8, value string) (*Variable, error)

+ func NewVariableFromSection(section *ini.Section, name string, nodeId uint8, index uint16, subindex uint8) (*Variable, error)

+ func (variable *Variable) DataLength() uint32

+ func (variable *Variable) DefaultValue() []byte

+ type VariableList struct

+ Variables []*Variable

+ func NewArray(length uint8) *VariableList

+ func NewRecord() *VariableList

+ func (rec *VariableList) AddSubObject(subindex uint8, name string, datatype uint8, attribute uint8, value string) (*Variable, error)

+ func (rec *VariableList) GetSubObject(subindex uint8) (*Variable, error)