ttn 2.1.0

connect

Connects and starts the client in the background. This function also re-establishes the client’s connection in case it was closed.

client.connect()

close

Disconnects and stops the client from which the method is called.

client.close()

Using Callbacks

The callback functions are functions which are executed when a trigger event happens.

client.set_uplink_callback(uplink_callback)

client.set_connect_callback(connect_callback)

client.set_downlink_callback(downlinkCallback)

client.set_close_callback(close_callback)

send

Sends a downlink to the device.

client.send(dev_id, payload, port=1, confirmation=False, schedule="replace")

• dev_id: string the ID of the device which will receive the message.

• payload: the payload of the message to be published to the broker. It can be an hexadecimal string, a base64 string like AQ== (this will send the raw payload 01 to your device) or a dictionary of JSON nature. Here is an example of a dictionary argument that could be passed to the method:

{ "led_state": "on", "counter": 1 }

In case it’s a dictionary with fields, please make sure the encoder function (Payload Formats section) of the application is set to make sense of the informations transmitted in each field.

• port: int the port of the device to which the message will be sent.

• confirmation: boolean this boolean indicates if you wish to receive a confirmation after sending the downlink message.

• schedule: string this string provides the type of schedule on which the message should be sent. It can take the following values: first, last, replace.

UplinkMessage

This type of object is constructed dynamically from the message received by the client, so this means some attributes can change from one message to another. Here are some constant attributes usually found in UplinkMessage objects:

• app_id: the application ID to which the device is registered

• dev_id: the ID of the device

• port: the port number on which the message was sent

• payload_raw: a buffer which contains the payload in hexadecimal

• metadata: this field is another object which contains all the metadata of the message. Such as: the date, the frequency, the data rate and the list of gateways.

get

Gives back the **Application**.

client.get()

set_payload_format

Sets the payload format of the application.

client.set_payload_format(payload_format)

• payload_format: string the new payload format. Example: custom

set_custom_payload_functions

Sets the payload functions of the application.

client.set_custom_payload_functions(encoder="", decoder="", validator="", converter="")

• decoder: string Javascript decoder function.

• encoder: string Javascript encoder function.

• validator: string Javascript validator function.

• converter: string Javascript converter function.

  Arguments left empty are ignored and won’t be updated. Example:

decoder_fn = """function Decoder(payload) {
   return { led: 1 };
}"""
client.set_custom_payload_functions(decoder=decoder_fn)

unregister

Unregisters the application.

client.unregister()

register_device

Registers a new device to the application.

client.register_device(dev_id, device)

• dev_id: string the id of the device to be registered.

• device: dictionary the dictionary with fields to be set as a new device of the application. See the Device section to know the structure of the dictionary that should be passed and the name of the fields.

device

Gives back the **Device** object of the given id.

client.device(dev_id)

• dev_id: string the id of the device.

devices

Gives back the list of all the devices registered to the application.

client.devices()

update_device

Updates an already existing device of the application.

client.update_device(dev_id, updates)

• dev_id: string the id of the device to be updated.

• updates: dictionary a dictionary with the fields to be updated in the device.

delete_device

Deletes the device with the given id.

client.delete_device(dev_id)

• dev_id: string the id of the device to be deleted.

Device

This objet is returned by the method device() of the ApplicationClient class. Here are its attributes:

• app_id: string

• dev_id: string

• latitude: float

• longitude: float

• altitude: float

• description: string

• attributes: dictionary

• lorawan_device: dictionary

  • app_eui: string 8 bytes in hexadecimal

  • dev_eui: string 8 bytes in hexadecimal

  • dev_addr: string 4 bytes in hexadecimal

  • nwk_s_key: string 16 bytes in hexadecimal

  • app_s_key: string 16 bytes in hexadecimal

  • app_key: string 16 bytes in hexadecimal

  • f_cnt_up: int

  • f_cnt_down: int

  • disable_f_cnt_check: boolean

  • uses32_bit_f_cnt: boolean

Application

This object is returned by the method get() of the ApplicationClient class. Here are its attributes:

• app_id: string

• payload_format: string

• decoder: string

• encoder: string

• converter: string

• validator: string

• register_on_join_access_key: string

data

Creates an **MQTTClient** object.

handler.data()

Returns an **MQTTClient** object.

application

Creates an **ApplicationClient** object

handler.application()

Returns an **ApplicationClient** object.