hololinked.server.mqtt.MQTTPublisher
Bases: BaseProtocolServer
MQTT Publisher.
All events and observable properties defined on the Thing will be published to MQTT topics with topic name "{thing id}/{event name}".
For setting up an MQTT broker if one does not exist, see infrastructure project.
Source code in repo/hololinked/hololinked/server/mqtt/server.py
21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 | |
Attributes
ssl_context
class-attribute
instance-attribute
The SSL context to use for secure connections, or None for no SSL
config
class-attribute
instance-attribute
Runtime configuration for the MQTT publisher
things
instance-attribute
Every served Thing, by id. Sub-things are not served.
Functions
__init__
__init__(hostname: str, port: int, username: str, password: str, qos: int = 1, things: Optional[list[Thing]] = None, config: Optional[dict] = None, use_websocket: bool = False, **kwargs)
Initialize the MQTT publisher.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
|
str
|
The MQTT broker hostname |
required |
|
int
|
The MQTT broker port |
required |
|
str
|
The MQTT broker username |
required |
|
str
|
The MQTT broker password |
required |
|
int
|
The (global) MQTT QoS level to use for publishing messages |
1
|
|
Optional[list[Thing]]
|
The |
None
|
|
Optional[dict]
|
Additional runtime configuration for the MQTT publisher, see |
None
|
|
bool
|
Whether to use WebSocket transport instead of TCP |
False
|
|
Additional keyword arguments |
{}
|
Source code in repo/hololinked/hololinked/server/mqtt/server.py
from_params
classmethod
Source code in repo/hololinked/hololinked/server/mqtt/server.py
add_thing
Adds a thing to the things being served.
Sub-things are not served - see EventLoop.add_thing, which does not register them
either.
Source code in repo/hololinked/hololinked/core/interfaces/protocol_server.py
add_things
add_property
add_property(name: str, thing: Thing, topic_name: str, publisher: type[TopicPublisher] | None = None, qos: int | None = None) -> None
Alias for add_observable.
Source code in repo/hololinked/hololinked/server/mqtt/server.py
add_action
Add an action to be served.
Raises:
| Type | Description |
|---|---|
NotImplementedError
|
if the protocol does not support this operation |
Source code in repo/hololinked/hololinked/core/interfaces/protocol_server.py
add_event
add_event(name: str, thing: Thing, topic_name: str, publisher: type[TopicPublisher] | None = None, qos: int | None = None) -> None
Add an event with a custom MQTT topic name.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
|
str
|
The name of the event |
required |
|
Thing
|
The Thing containing the event |
required |
|
str
|
The custom MQTT topic name to use |
required |
|
type[TopicPublisher] | None
|
Custom publisher class (default: None uses config.topic_publisher) |
None
|
|
int | None
|
MQTT QoS level (default: None uses global config.qos) |
None
|
Raises:
| Type | Description |
|---|---|
TypeError
|
If |
Source code in repo/hololinked/hololinked/server/mqtt/server.py
setup
async
Setup MQTT publishers per Thing post connection to broker.
Source code in repo/hololinked/hololinked/server/mqtt/server.py
start
async
Sets up the MQTT client and starts publishing events from the Things.
All events are dispatched to their own async tasks. This method returns and
creates side-effects only & does not block. Use the run() method instead for a blocking call.
Source code in repo/hololinked/hololinked/server/mqtt/server.py
start_publishers
async
Start the publishers for a given Thing.
Raises:
| Type | Description |
|---|---|
ValueError
|
if the |
Source code in repo/hololinked/hololinked/server/mqtt/server.py
run
Run the server and serve your things.
Use this method if this is the only running protocol. Blocks.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
|
bool
|
whether to run in a forked thread |
False
|
|
bool
|
whether to print a welcome message on startup, like the ports and access points |
True
|