DS18B20

From: Analog Devices

Class: herosdevices.hardware.analog_devices.ds18b20.DS18B20

Driver Quality Index: beta

One wire temperature sensor type DS18B20.

Arguments

Bold arguments are mandatory. For more information on the listed arguments refer to the class documentation: herosdevices.hardware.analog_devices.ds18b20.DS18B20 If parameters appear in this list but not in the class definition, please recursively check the linked base classes for the definition of the parameter.

Argument	Type	Default Value	Description
device_id	<class ‘str’>		id of the onewire device as named by the w1 Linux kernel driver.
sysfs_path	<class ‘str’>	/sys/bus/w1/	sys path of the Linux w1 kernel driver

Example JSON for BOSS

The following JSON strings can be used to start a HERO device representation of DS18B20 using BOSS.

{
    "_id": "temp-main-table",
    "classname": "herosdevices.hardware.analog_devices.DS18B20",
    "arguments": {
        "device_id": "28-06201996d98f"
    },
    "datasource": {
        "async": false,
        "interval": 5,
        "observables": {
            "temperature": {
                "conversion": "x/1000.",
                "unit": "degC",
                "boundaries": [
                    [
                        21,
                        22
                    ],
                    [
                        20,
                        24
                    ],
                    [
                        15,
                        30
                    ]
                ]
            }
        }
    }
}

^{from examples/analog_devices/ds18b20.json}

{
    "_id": "my_DS18B20",
    "classname": "herosdevices.hardware.analog_devices.ds18b20.DS18B20",
    "arguments": {
        "device_id": "<class 'str'>",
        "sysfs_path": "/sys/bus/w1/"
    }
}

^{generated from signature}

Inheritance

digraph inheritance66a8e0638f { bgcolor=transparent; rankdir=TB; size=""; "herosdevices.core.bus.onewire.OneWire" [URL="../../../autoapi/herosdevices/core/bus/onewire/index.html#herosdevices.core.bus.onewire.OneWire",color="#5fabe8",fillcolor="#5fabe827",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,penwidth=2,shape=box,style="rounded,filled",target="_top",tooltip="A read-only Onewire driver that relies on the Linux kernel w1 driver."]; "herosdevices.hardware.analog_devices.ds18b20.DS18B20" [URL="../../../autoapi/herosdevices/hardware/analog_devices/ds18b20/index.html#herosdevices.hardware.analog_devices.ds18b20.DS18B20",color="#5fabe8",fillcolor="#5fabe827",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,penwidth=2,shape=box,style="rounded,filled",target="_top",tooltip="One wire temperature sensor type DS18B20."]; "herosdevices.core.bus.onewire.OneWire" -> "herosdevices.hardware.analog_devices.ds18b20.DS18B20" [arrowsize=1,color="#5fabe8",dir="back",penwidth=2,style="setlinewidth(0.5)"]; "herosdevices.interfaces.atomiq.Measurable" -> "herosdevices.hardware.analog_devices.ds18b20.DS18B20" [arrowsize=1,color="#5fabe8",dir="back",penwidth=2,style="setlinewidth(0.5)"]; "herosdevices.interfaces.Interface" [URL="../../../autoapi/herosdevices/interfaces/index.html#herosdevices.interfaces.Interface",color="#5fabe8",fillcolor="#5fabe827",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,penwidth=2,shape=box,style="rounded,filled",target="_top",tooltip="Generic Interface to describe and check capabilities of a device driver."]; "herosdevices.interfaces.atomiq.AtomiqInterface" [URL="../../../autoapi/herosdevices/interfaces/atomiq/index.html#herosdevices.interfaces.atomiq.AtomiqInterface",color="#5fabe8",fillcolor="#5fabe827",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,penwidth=2,shape=box,style="rounded,filled",target="_top",tooltip="This interface defines the necessary methods for a HERO to seamlessly being converted into an atomiq component."]; "herosdevices.interfaces.Interface" -> "herosdevices.interfaces.atomiq.AtomiqInterface" [arrowsize=1,color="#5fabe8",dir="back",penwidth=2,style="setlinewidth(0.5)"]; "herosdevices.interfaces.atomiq.Measurable" [URL="../../../autoapi/herosdevices/interfaces/atomiq/index.html#herosdevices.interfaces.atomiq.Measurable",color="#5fabe8",fillcolor="#5fabe827",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,penwidth=2,shape=box,style="rounded,filled",target="_top",tooltip="HERO implementation of :external+atomiq:py:class:`atomiq.components.primitives.Measurable`."]; "herosdevices.interfaces.atomiq.AtomiqInterface" -> "herosdevices.interfaces.atomiq.Measurable" [arrowsize=1,color="#5fabe8",dir="back",penwidth=2,style="setlinewidth(0.5)"]; }