industrial_ptc_bricklet

package
Version: v0.0.0-...-d0a6af2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 8, 2022 License: CC0-1.0 Imports: 5 Imported by: 0

Documentation

Overview

Reads temperatures from Pt100 und Pt1000 sensors.

See also the documentation here: https://www.tinkerforge.com/en/doc/Software/Bricklets/IndustrialPTC_Bricklet_Go.html.

Index

Constants

View Source
const DeviceDisplayName = "Industrial PTC Bricklet"
View Source
const DeviceIdentifier = 2164

Variables

This section is empty.

Functions

This section is empty.

Types

type BootloaderMode

type BootloaderMode = uint8
const (
	BootloaderModeBootloader                    BootloaderMode = 0
	BootloaderModeFirmware                      BootloaderMode = 1
	BootloaderModeBootloaderWaitForReboot       BootloaderMode = 2
	BootloaderModeFirmwareWaitForReboot         BootloaderMode = 3
	BootloaderModeFirmwareWaitForEraseAndReboot BootloaderMode = 4
)

type BootloaderStatus

type BootloaderStatus = uint8
const (
	BootloaderStatusOK                        BootloaderStatus = 0
	BootloaderStatusInvalidMode               BootloaderStatus = 1
	BootloaderStatusNoChange                  BootloaderStatus = 2
	BootloaderStatusEntryFunctionNotPresent   BootloaderStatus = 3
	BootloaderStatusDeviceIdentifierIncorrect BootloaderStatus = 4
	BootloaderStatusCRCMismatch               BootloaderStatus = 5
)

type FilterOption

type FilterOption = uint8
const (
	FilterOption50Hz FilterOption = 0
	FilterOption60Hz FilterOption = 1
)

type Function

type Function = uint8
const (
	FunctionGetTemperature                          Function = 1
	FunctionSetTemperatureCallbackConfiguration     Function = 2
	FunctionGetTemperatureCallbackConfiguration     Function = 3
	FunctionGetResistance                           Function = 5
	FunctionSetResistanceCallbackConfiguration      Function = 6
	FunctionGetResistanceCallbackConfiguration      Function = 7
	FunctionSetNoiseRejectionFilter                 Function = 9
	FunctionGetNoiseRejectionFilter                 Function = 10
	FunctionIsSensorConnected                       Function = 11
	FunctionSetWireMode                             Function = 12
	FunctionGetWireMode                             Function = 13
	FunctionSetMovingAverageConfiguration           Function = 14
	FunctionGetMovingAverageConfiguration           Function = 15
	FunctionSetSensorConnectedCallbackConfiguration Function = 16
	FunctionGetSensorConnectedCallbackConfiguration Function = 17
	FunctionGetSPITFPErrorCount                     Function = 234
	FunctionSetBootloaderMode                       Function = 235
	FunctionGetBootloaderMode                       Function = 236
	FunctionSetWriteFirmwarePointer                 Function = 237
	FunctionWriteFirmware                           Function = 238
	FunctionSetStatusLEDConfig                      Function = 239
	FunctionGetStatusLEDConfig                      Function = 240
	FunctionGetChipTemperature                      Function = 242
	FunctionReset                                   Function = 243
	FunctionWriteUID                                Function = 248
	FunctionReadUID                                 Function = 249
	FunctionGetIdentity                             Function = 255
	FunctionCallbackTemperature                     Function = 4
	FunctionCallbackResistance                      Function = 8
	FunctionCallbackSensorConnected                 Function = 18
)

type IndustrialPTCBricklet

type IndustrialPTCBricklet struct {
	// contains filtered or unexported fields
}

func New

Creates an object with the unique device ID `uid`. This object can then be used after the IP Connection `ipcon` is connected.

func (*IndustrialPTCBricklet) DeregisterResistanceCallback

func (device *IndustrialPTCBricklet) DeregisterResistanceCallback(registrationId uint64)

Remove a registered Resistance callback.

func (*IndustrialPTCBricklet) DeregisterSensorConnectedCallback

func (device *IndustrialPTCBricklet) DeregisterSensorConnectedCallback(registrationId uint64)

Remove a registered Sensor Connected callback.

func (*IndustrialPTCBricklet) DeregisterTemperatureCallback

func (device *IndustrialPTCBricklet) DeregisterTemperatureCallback(registrationId uint64)

Remove a registered Temperature callback.

func (*IndustrialPTCBricklet) GetAPIVersion

func (device *IndustrialPTCBricklet) GetAPIVersion() [3]uint8

Returns the version of the API definition (major, minor, revision) implemented by this API bindings. This is neither the release version of this API bindings nor does it tell you anything about the represented Brick or Bricklet.

func (*IndustrialPTCBricklet) GetBootloaderMode

func (device *IndustrialPTCBricklet) GetBootloaderMode() (mode BootloaderMode, err error)

Returns the current bootloader mode, see SetBootloaderMode.

Associated constants:

  • BootloaderModeBootloader
  • BootloaderModeFirmware
  • BootloaderModeBootloaderWaitForReboot
  • BootloaderModeFirmwareWaitForReboot
  • BootloaderModeFirmwareWaitForEraseAndReboot

func (*IndustrialPTCBricklet) GetChipTemperature

func (device *IndustrialPTCBricklet) GetChipTemperature() (temperature int16, err error)

Returns the temperature as measured inside the microcontroller. The value returned is not the ambient temperature!

The temperature is only proportional to the real temperature and it has bad accuracy. Practically it is only useful as an indicator for temperature changes.

func (*IndustrialPTCBricklet) GetIdentity

func (device *IndustrialPTCBricklet) GetIdentity() (uid string, connectedUid string, position rune, hardwareVersion [3]uint8, firmwareVersion [3]uint8, deviceIdentifier uint16, err error)

Returns the UID, the UID where the Bricklet is connected to, the position, the hardware and firmware version as well as the device identifier.

The position can be 'a', 'b', 'c', 'd', 'e', 'f', 'g' or 'h' (Bricklet Port). A Bricklet connected to an `Isolator Bricklet <isolator_bricklet>` is always at position 'z'.

The device identifier numbers can be found `here <device_identifier>`. |device_identifier_constant|

func (*IndustrialPTCBricklet) GetMovingAverageConfiguration

func (device *IndustrialPTCBricklet) GetMovingAverageConfiguration() (movingAverageLengthResistance uint16, movingAverageLengthTemperature uint16, err error)

Returns the moving average configuration as set by SetMovingAverageConfiguration.

func (*IndustrialPTCBricklet) GetNoiseRejectionFilter

func (device *IndustrialPTCBricklet) GetNoiseRejectionFilter() (filter FilterOption, err error)

Returns the noise rejection filter option as set by SetNoiseRejectionFilter

Associated constants:

  • FilterOption50Hz
  • FilterOption60Hz

func (*IndustrialPTCBricklet) GetResistance

func (device *IndustrialPTCBricklet) GetResistance() (resistance int32, err error)

Returns the value as measured by the MAX31865 precision delta-sigma ADC.

The value can be converted with the following formulas:

* Pt100: resistance = (value * 390) / 32768 * Pt1000: resistance = (value * 3900) / 32768

If you want to get the value periodically, it is recommended to use the RegisterResistanceCallback callback. You can set the callback configuration with SetResistanceCallbackConfiguration.

func (*IndustrialPTCBricklet) GetResistanceCallbackConfiguration

func (device *IndustrialPTCBricklet) GetResistanceCallbackConfiguration() (period uint32, valueHasToChange bool, option ThresholdOption, min int32, max int32, err error)

Returns the callback configuration as set by SetResistanceCallbackConfiguration.

Associated constants:

  • ThresholdOptionOff
  • ThresholdOptionOutside
  • ThresholdOptionInside
  • ThresholdOptionSmaller
  • ThresholdOptionGreater

func (*IndustrialPTCBricklet) GetResponseExpected

func (device *IndustrialPTCBricklet) GetResponseExpected(functionID Function) (bool, error)

Returns the response expected flag for the function specified by the function ID parameter. It is true if the function is expected to send a response, false otherwise.

For getter functions this is enabled by default and cannot be disabled, because those functions will always send a response. For callback configuration functions it is enabled by default too, but can be disabled by SetResponseExpected. For setter functions it is disabled by default and can be enabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is sent and errors are silently ignored, because they cannot be detected.

See SetResponseExpected for the list of function ID constants available for this function.

func (*IndustrialPTCBricklet) GetSPITFPErrorCount

func (device *IndustrialPTCBricklet) GetSPITFPErrorCount() (errorCountAckChecksum uint32, errorCountMessageChecksum uint32, errorCountFrame uint32, errorCountOverflow uint32, err error)

Returns the error count for the communication between Brick and Bricklet.

The errors are divided into

* ACK checksum errors, * message checksum errors, * framing errors and * overflow errors.

The errors counts are for errors that occur on the Bricklet side. All Bricks have a similar function that returns the errors on the Brick side.

func (*IndustrialPTCBricklet) GetSensorConnectedCallbackConfiguration

func (device *IndustrialPTCBricklet) GetSensorConnectedCallbackConfiguration() (enabled bool, err error)

Returns the configuration as set by SetSensorConnectedCallbackConfiguration.

func (*IndustrialPTCBricklet) GetStatusLEDConfig

func (device *IndustrialPTCBricklet) GetStatusLEDConfig() (config StatusLEDConfig, err error)

Returns the configuration as set by SetStatusLEDConfig

Associated constants:

  • StatusLEDConfigOff
  • StatusLEDConfigOn
  • StatusLEDConfigShowHeartbeat
  • StatusLEDConfigShowStatus

func (*IndustrialPTCBricklet) GetTemperature

func (device *IndustrialPTCBricklet) GetTemperature() (temperature int32, err error)

Returns the temperature of the connected sensor.

If you want to get the value periodically, it is recommended to use the RegisterTemperatureCallback callback. You can set the callback configuration with SetTemperatureCallbackConfiguration.

func (*IndustrialPTCBricklet) GetTemperatureCallbackConfiguration

func (device *IndustrialPTCBricklet) GetTemperatureCallbackConfiguration() (period uint32, valueHasToChange bool, option ThresholdOption, min int32, max int32, err error)

Returns the callback configuration as set by SetTemperatureCallbackConfiguration.

Associated constants:

  • ThresholdOptionOff
  • ThresholdOptionOutside
  • ThresholdOptionInside
  • ThresholdOptionSmaller
  • ThresholdOptionGreater

func (*IndustrialPTCBricklet) GetWireMode

func (device *IndustrialPTCBricklet) GetWireMode() (mode WireMode, err error)

Returns the wire mode as set by SetWireMode

Associated constants:

  • WireMode2
  • WireMode3
  • WireMode4

func (*IndustrialPTCBricklet) IsSensorConnected

func (device *IndustrialPTCBricklet) IsSensorConnected() (connected bool, err error)

Returns *true* if the sensor is connected correctly.

If this function returns *false*, there is either no Pt100 or Pt1000 sensor connected, the sensor is connected incorrectly or the sensor itself is faulty.

If you want to get the status automatically, it is recommended to use the RegisterSensorConnectedCallback callback. You can set the callback configuration with SetSensorConnectedCallbackConfiguration.

func (*IndustrialPTCBricklet) ReadUID

func (device *IndustrialPTCBricklet) ReadUID() (uid uint32, err error)

Returns the current UID as an integer. Encode as Base58 to get the usual string version.

func (*IndustrialPTCBricklet) RegisterResistanceCallback

func (device *IndustrialPTCBricklet) RegisterResistanceCallback(fn func(int32)) uint64

This callback is triggered periodically according to the configuration set by SetResistanceCallbackConfiguration.

The parameter is the same as GetResistance.

func (*IndustrialPTCBricklet) RegisterSensorConnectedCallback

func (device *IndustrialPTCBricklet) RegisterSensorConnectedCallback(fn func(bool)) uint64

This callback is triggered periodically according to the configuration set by SetSensorConnectedCallbackConfiguration.

The parameter is the same as IsSensorConnected.

func (*IndustrialPTCBricklet) RegisterTemperatureCallback

func (device *IndustrialPTCBricklet) RegisterTemperatureCallback(fn func(int32)) uint64

This callback is triggered periodically according to the configuration set by SetTemperatureCallbackConfiguration.

The parameter is the same as GetTemperature.

func (*IndustrialPTCBricklet) Reset

func (device *IndustrialPTCBricklet) Reset() (err error)

Calling this function will reset the Bricklet. All configurations will be lost.

After a reset you have to create new device objects, calling functions on the existing ones will result in undefined behavior!

func (*IndustrialPTCBricklet) SetBootloaderMode

func (device *IndustrialPTCBricklet) SetBootloaderMode(mode BootloaderMode) (status BootloaderStatus, err error)

Sets the bootloader mode and returns the status after the requested mode change was instigated.

You can change from bootloader mode to firmware mode and vice versa. A change from bootloader mode to firmware mode will only take place if the entry function, device identifier and CRC are present and correct.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

Associated constants:

  • BootloaderModeBootloader
  • BootloaderModeFirmware
  • BootloaderModeBootloaderWaitForReboot
  • BootloaderModeFirmwareWaitForReboot
  • BootloaderModeFirmwareWaitForEraseAndReboot
  • BootloaderStatusOK
  • BootloaderStatusInvalidMode
  • BootloaderStatusNoChange
  • BootloaderStatusEntryFunctionNotPresent
  • BootloaderStatusDeviceIdentifierIncorrect
  • BootloaderStatusCRCMismatch

func (*IndustrialPTCBricklet) SetMovingAverageConfiguration

func (device *IndustrialPTCBricklet) SetMovingAverageConfiguration(movingAverageLengthResistance uint16, movingAverageLengthTemperature uint16) (err error)

Sets the length of a https://en.wikipedia.org/wiki/Moving_average for the resistance and temperature.

Setting the length to 1 will turn the averaging off. With less averaging, there is more noise on the data.

New data is gathered every 20ms. With a moving average of length 1000 the resulting averaging window has a length of 20s. If you want to do long term measurements the longest moving average will give the cleanest results.

The default values match the non-changeable averaging settings of the old PTC Bricklet 1.0

func (*IndustrialPTCBricklet) SetNoiseRejectionFilter

func (device *IndustrialPTCBricklet) SetNoiseRejectionFilter(filter FilterOption) (err error)

Sets the noise rejection filter to either 50Hz (0) or 60Hz (1). Noise from 50Hz or 60Hz power sources (including harmonics of the AC power's fundamental frequency) is attenuated by 82dB.

Associated constants:

  • FilterOption50Hz
  • FilterOption60Hz

func (*IndustrialPTCBricklet) SetResistanceCallbackConfiguration

func (device *IndustrialPTCBricklet) SetResistanceCallbackConfiguration(period uint32, valueHasToChange bool, option ThresholdOption, min int32, max int32) (err error)

The period is the period with which the RegisterResistanceCallback callback is triggered periodically. A value of 0 turns the callback off.

If the `value has to change`-parameter is set to true, the callback is only triggered after the value has changed. If the value didn't change within the period, the callback is triggered immediately on change.

If it is set to false, the callback is continuously triggered with the period, independent of the value.

It is furthermore possible to constrain the callback with thresholds.

The `option`-parameter together with min/max sets a threshold for the RegisterResistanceCallback callback.

The following options are possible:

Option| Description
--- | ---
'x'|    Threshold is turned off
'o'|    Threshold is triggered when the value is *outside* the min and max values
'i'|    Threshold is triggered when the value is *inside* or equal to the min and max values
'<'|    Threshold is triggered when the value is smaller than the min value (max is ignored)
'>'|    Threshold is triggered when the value is greater than the min value (max is ignored)

If the option is set to 'x' (threshold turned off) the callback is triggered with the fixed period.

Associated constants:

  • ThresholdOptionOff
  • ThresholdOptionOutside
  • ThresholdOptionInside
  • ThresholdOptionSmaller
  • ThresholdOptionGreater

func (*IndustrialPTCBricklet) SetResponseExpected

func (device *IndustrialPTCBricklet) SetResponseExpected(functionID Function, responseExpected bool) error

Changes the response expected flag of the function specified by the function ID parameter. This flag can only be changed for setter (default value: false) and callback configuration functions (default value: true). For getter functions it is always enabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is sent and errors are silently ignored, because they cannot be detected.

func (*IndustrialPTCBricklet) SetResponseExpectedAll

func (device *IndustrialPTCBricklet) SetResponseExpectedAll(responseExpected bool)

Changes the response expected flag for all setter and callback configuration functions of this device at once.

func (*IndustrialPTCBricklet) SetSensorConnectedCallbackConfiguration

func (device *IndustrialPTCBricklet) SetSensorConnectedCallbackConfiguration(enabled bool) (err error)

If you enable this callback, the RegisterSensorConnectedCallback callback is triggered every time a Pt sensor is connected/disconnected.

func (*IndustrialPTCBricklet) SetStatusLEDConfig

func (device *IndustrialPTCBricklet) SetStatusLEDConfig(config StatusLEDConfig) (err error)

Sets the status LED configuration. By default the LED shows communication traffic between Brick and Bricklet, it flickers once for every 10 received data packets.

You can also turn the LED permanently on/off or show a heartbeat.

If the Bricklet is in bootloader mode, the LED is will show heartbeat by default.

Associated constants:

  • StatusLEDConfigOff
  • StatusLEDConfigOn
  • StatusLEDConfigShowHeartbeat
  • StatusLEDConfigShowStatus

func (*IndustrialPTCBricklet) SetTemperatureCallbackConfiguration

func (device *IndustrialPTCBricklet) SetTemperatureCallbackConfiguration(period uint32, valueHasToChange bool, option ThresholdOption, min int32, max int32) (err error)

The period is the period with which the RegisterTemperatureCallback callback is triggered periodically. A value of 0 turns the callback off.

If the `value has to change`-parameter is set to true, the callback is only triggered after the value has changed. If the value didn't change within the period, the callback is triggered immediately on change.

If it is set to false, the callback is continuously triggered with the period, independent of the value.

It is furthermore possible to constrain the callback with thresholds.

The `option`-parameter together with min/max sets a threshold for the RegisterTemperatureCallback callback.

The following options are possible:

Option| Description
--- | ---
'x'|    Threshold is turned off
'o'|    Threshold is triggered when the value is *outside* the min and max values
'i'|    Threshold is triggered when the value is *inside* or equal to the min and max values
'<'|    Threshold is triggered when the value is smaller than the min value (max is ignored)
'>'|    Threshold is triggered when the value is greater than the min value (max is ignored)

If the option is set to 'x' (threshold turned off) the callback is triggered with the fixed period.

Associated constants:

  • ThresholdOptionOff
  • ThresholdOptionOutside
  • ThresholdOptionInside
  • ThresholdOptionSmaller
  • ThresholdOptionGreater

func (*IndustrialPTCBricklet) SetWireMode

func (device *IndustrialPTCBricklet) SetWireMode(mode WireMode) (err error)

Sets the wire mode of the sensor. Possible values are 2, 3 and 4 which correspond to 2-, 3- and 4-wire sensors. The value has to match the jumper configuration on the Bricklet.

Associated constants:

  • WireMode2
  • WireMode3
  • WireMode4

func (*IndustrialPTCBricklet) SetWriteFirmwarePointer

func (device *IndustrialPTCBricklet) SetWriteFirmwarePointer(pointer uint32) (err error)

Sets the firmware pointer for WriteFirmware. The pointer has to be increased by chunks of size 64. The data is written to flash every 4 chunks (which equals to one page of size 256).

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

func (*IndustrialPTCBricklet) WriteFirmware

func (device *IndustrialPTCBricklet) WriteFirmware(data [64]uint8) (status uint8, err error)

Writes 64 Bytes of firmware at the position as written by SetWriteFirmwarePointer before. The firmware is written to flash every 4 chunks.

You can only write firmware in bootloader mode.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

func (*IndustrialPTCBricklet) WriteUID

func (device *IndustrialPTCBricklet) WriteUID(uid uint32) (err error)

Writes a new UID into flash. If you want to set a new UID you have to decode the Base58 encoded UID string into an integer first.

We recommend that you use Brick Viewer to change the UID.

type StatusLEDConfig

type StatusLEDConfig = uint8
const (
	StatusLEDConfigOff           StatusLEDConfig = 0
	StatusLEDConfigOn            StatusLEDConfig = 1
	StatusLEDConfigShowHeartbeat StatusLEDConfig = 2
	StatusLEDConfigShowStatus    StatusLEDConfig = 3
)

type ThresholdOption

type ThresholdOption = rune
const (
	ThresholdOptionOff     ThresholdOption = 'x'
	ThresholdOptionOutside ThresholdOption = 'o'
	ThresholdOptionInside  ThresholdOption = 'i'
	ThresholdOptionSmaller ThresholdOption = '<'
	ThresholdOptionGreater ThresholdOption = '>'
)

type WireMode

type WireMode = uint8
const (
	WireMode2 WireMode = 2
	WireMode3 WireMode = 3
	WireMode4 WireMode = 4
)

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL