Raspberry Pi Peripherals Library Documentation ¶ Company : CODESYS Title : Raspberry Pi Peripherals Version : 4.10.0.0 Categories : Target|3S - Smart Software Solutions GmbH Namespace : RasPi Author : CODESYS Development GmbH Placeholder : Raspberry Pi Peripherals Description [ 1 ] ¶ Library containing device support of Raspberry Pi Peripherals Contents: ¶ Raspberry Peripherals 1-wire SPI i2c Indices and tables ¶ [ 1 ] Based on Raspberry Pi Peripherals.library, last modified 25.10.2023, 14:07:31. LibDoc 4.4.0.0-b.37 The content file Raspberry Pi Peripherals.clean.json was generated with CODESYS V3.5 SP16 Patch 3 on 25.10.2023, 14:07:33.
Raspberry Peripherals ¶ 1-wire OneWire (FunctionBlock) DataPath (Property) ID (Property) SetIDFromString (Method) SetMasterInstance (Method) connector AfterReadInputs (Method) BeforeWriteOutputs (Method) Initialize (Method) status Operational (Property) OneWireMaster (FunctionBlock) AddDevice (Method) GetNumberOfSlaves (Method) Operational (Property) Path (Property) Scan (Method) OneWireUniqueID (FunctionBlock) StringRepresentation (Property) SPI spi (FunctionBlock) connector AfterReadInputs (Method) BeforeWriteOutputs (Method) internal transfer (Method) transferExt (Method) status Operational (Property) spiMaster (FunctionBlock) Operational (Property) readwrite-commands transferExt (Method) i2c i2c (FunctionBlock) connector AfterReadInputs (Method) BeforeWriteOutputs (Method) internal readwrite-commands read (Method) read8 (Method) readregister (Method) write (Method) write8 (Method) writeBits (Method) status Operational (Property) i2cMaster (FunctionBlock) Operational (Property) readwrite-commands read (Method) write (Method)
1-wire ¶ OneWire (FunctionBlock) DataPath (Property) ID (Property) SetIDFromString (Method) SetMasterInstance (Method) connector AfterReadInputs (Method) BeforeWriteOutputs (Method) Initialize (Method) status Operational (Property) OneWireMaster (FunctionBlock) AddDevice (Method) GetNumberOfSlaves (Method) Operational (Property) Path (Property) Scan (Method) OneWireUniqueID (FunctionBlock) StringRepresentation (Property)
OneWire (FB) ¶ FUNCTION_BLOCK OneWire This function block is the base class for 1-wire devices controlled via the global OneWireMaster instance gOneWireMaster . It is meant to be extended by other function blocks that overload the following methods/properties and replace it with their specific implementation, always including a call of the base implementation with super^.<MethodName>() : AfterReadInputs (reading input data) BeforeWriteOutputs (writing output data) Initialize [optional] (used to read parameters from the configuration) Operational [optional] (used to signal the status of the device) The body of this FB is called by the methods AfterReadInputs and BeforeWriteOutputs , where _xAfterReadInputs indicates the caller. InOut: Scope Name Type Initial Comment Input sDataFile STRING ‘/w1_slave’ name of file that inlcudes the data Properties: DataPath ID Operational Methods: SetIDFromString SetMasterInstance AfterReadInputs BeforeWriteOutputs Initialize Structure: DataPath (Property) ID (Property) SetIDFromString (Method) SetMasterInstance (Method) connector AfterReadInputs (Method) BeforeWriteOutputs (Method) Initialize (Method) status Operational (Property)
OneWire.DataPath (PROP) ¶ PROPERTY DataPath : STRING This property returns the path in the file system that contains the data
OneWire.ID (PROP) ¶ PROPERTY ID : OneWireUniqueID Gets or sets the device ID
OneWire.SetIDFromString (METH) ¶ METHOD SetIDFromString : BOOL allows to set the device ID with a string, that needs to have the format XX-AABBCCDDEEFF return value TRUE indicates that the setting was successful. InOut: Scope Name Type Return SetIDFromString BOOL Input sID STRING
OneWire.SetMasterInstance (METH) ¶ METHOD SetMasterInstance : BOOL with this method the internal pointer to the master device can be set. note: this method can only be applied when the slave device is not part of the device tree (where all this action is done automatically), but manually instanciated. Then, it must be linked to the master instance with this function. InOut: Scope Name Type Return SetMasterInstance BOOL Input pMaster POINTER TO OneWireMaster
connector ¶ AfterReadInputs (Method) BeforeWriteOutputs (Method) Initialize (Method)
status ¶ Operational (Property)