def delete(self, appeui):
"""Method to handle application DELETE requests
Args:
appeui (int): Application EUI
"""
try:
# Check that no devices exist with this AppEUI.
devices = yield Device.find(where=['appeui = ?', appeui], limit=1)
if devices is not None:
abort(400, message={'error': "Cannot delete - devices exist " \
"with Application EUI {}".format(euiString(appeui))})
# Return a 404 if not found.
app = yield Application.find(where=['appeui = ?', appeui], limit=1)
if app is None:
abort(404,
message={
'error':
"Application {} doesn't exist.".format(
euiString(appeui))
})
yield app.delete()
returnValue(({}, 200))
except TimeoutError:
log.error("REST API timeout retrieving application {appeui}",
appeui=euiString(appeui))
def get(self, appeui):
"""Method to handle application property GET requests
Args:
appeui (int): Application EUI
port (int): Application property port
"""
try:
app = yield Application.find(where=['appeui = ?', appeui], limit=1)
# Return a 404 if not found.
if app is None:
abort(404,
message={
'error':
"Application {} doesn't exist.".format(
euiString(appeui))
})
port = self.args['port']
p = yield AppProperty.find(
where=['application_id = ? AND port = ?', app.id, port])
if p is None:
abort(404,
message={'error': "Application property doesn't exist."})
data = marshal(p, self.fields)
returnValue(data)
except TimeoutError:
log.error(
"REST API timeout get request for application {appeui} "
"property {port}",
appeui=euiString(appeui),
port=port)
def put(self, appeui):
"""Method to handle application PUT requests
Args:
appeui (int): Application EUI
"""
try:
app = yield Application.find(where=['appeui = ?', appeui], limit=1)
# Return a 404 if not found.
if app is None:
abort(404,
message={
'error':
"Application {} doesn't exist.".format(
euiString(appeui))
})
kwargs = {}
for a, v in self.args.items():
if v is not None and v != getattr(app, a):
kwargs[a] = v
setattr(app, a, v)
(valid, message) = yield app.valid()
if not valid:
abort(400, message=message)
# Update the model
if kwargs:
app.update(**kwargs)
returnValue(({}, 200))
except TimeoutError:
log.error("REST API timeout retrieving application {appeui}",
appeui=euiString(appeui))
def get(self, appeui):
"""Method to get all app properties"""
try:
# Return a 404 if the application is not found.
app = yield Application.find(where=['appeui = ?', appeui], limit=1)
if app is None:
abort(404,
message={
'error':
"Application {} doesn't exist.".format(
euiString(appeui))
})
# Get the properties
properties = yield app.properties.get()
if properties is None:
returnValue({})
data = {}
for i, p in enumerate(properties):
data[i] = marshal(p, self.fields)
returnValue(data)
except TimeoutError:
log.error(
"REST API timeout retrieving application {appeui} "
"properties",
appeui=euiString(appeui))
def _pollInboundMessages(self):
"""Poll Azure IOT hub for inbound messages and forward
them to the Network Server"""
# If we are running, return
if self.polling is True:
returnValue(None)
log.info("Azure IoT HTTPS interface '{name}' commencing "
"polling loop", name=self.name)
self.polling = True
# Get the applications associated with this interface.
apps = yield Application.find(where=['appinterface_id = ?', self.appinterface.id])
if apps is None:
self.polling = False
returnValue(None)
# Loop through the applications
for app in apps:
# Poll all devices associated with this app
devices = yield Device.find(where=['appeui = ?', app.appeui])
if devices is None:
returnValue(None)
for device in devices:
# Use the device appname property for the Azure devid,
# if it exists. Otherwise, use the device name property
devid = device.appname if device.appname else device.name
# Form the url, headers and parameters
url = 'https://{}/devices/{}/messages/devicebound'.format(
self.iothost, devid)
resuri = '{}/devices/{}'.format(self.iothost, devid)
headers = {'Authorization': self._iotHubSasToken(resuri)}
params = {'api-version': self.API_VERSION}
# Make the request, catch any exceptions
try:
r = requests.get(url, headers=headers,
params=params, timeout=self.TIMEOUT)
except requests.exceptions.RequestException:
log.debug("Application interface {name} could not poll "
"Azure IOT Hub {host} for device ID {device}",
name=self.name, host=self.iothost, device=devid)
continue
# Response code 204 indicates there is no data to be sent.
if r.status_code == 204:
continue
# Response code 200 means we have data to send to the device
elif r.status_code == 200:
appdata = r.content
self.netserver.inboundAppMessage(device.devaddr, appdata)
self.polling = False
def post(self):
"""Method to create an application property"""
appeui = self.args['appeui']
port = self.args['port']
name = self.args['name']
type = self.args['type']
message = {}
# Check for required args
required = {'appeui', 'port', 'name', 'type'}
for r in required:
if self.args[r] is None:
message[r] = "Missing the {} parameter.".format(r)
if message:
abort(400, message=message)
# Return a 404 if the application is not found.
app = yield Application.find(where=['appeui = ?', appeui], limit=1)
if app is None:
abort(404,
message={
'error':
"Application {} doesn't exist.".format(euiString(appeui))
})
# Check this property does not currently exist
exists = yield AppProperty.exists(
where=['application_id = ? AND port = ?', app.id, port])
if exists:
message = {
'error':
"Application property for appeui {}, port "
"{} exists".format(euiString(appeui), port)
}
abort(400, message=message)
# Create and validate
p = AppProperty(application_id=app.id, port=port, name=name, type=type)
(valid, message) = yield p.valid()
if not valid:
abort(400, message=message)
try:
prop = yield p.save()
if prop is None:
abort(500, message={'error': "Error saving the property."})
location = self.restapi.api.prefix + '/property/' + str(prop.id)
returnValue(({}, 201, {'Location': location}))
except TimeoutError:
log.error(
"REST API timeout post application {appeui} "
"property {port}",
appeui=euiString(appeui),
port=port)
def setUp(self):
# Bootstrap the database
fpath = os.path.realpath(__file__)
config = os.path.dirname(fpath) + '/database.cfg'
db = Database()
db.parseConfig(config)
db.start()
db.register()
self.device = yield Device.find(where=['appname = ?', 'azuredevice02'],
limit=1)
self.app = yield Application.find(
where=['appeui = ?', self.device.appeui], limit=1)
def checkInterface(self, appinterface_id):
"""Check the referenced interface is required to be active.
Args:
appinterface_id (int): Application interface id
"""
interface = self.getInterface(appinterface_id)
if interface is None:
returnValue(None)
# If there are no associated applications, stop the interface.
active = yield Application.find(
where=['appinterface_id = ?', appinterface_id])
#active = yield interface.apps()
if active is None:
interface.stop()
def put(self, appeui):
"""Method to handle application property PUT requests
Args:
appeui (int): Application EUI
"""
try:
app = yield Application.find(where=['appeui = ?', appeui], limit=1)
# Return a 404 if not found.
if app is None:
abort(404,
message={
'error':
"Application {} doesn't exist.".format(
euiString(appeui))
})
port = self.args['port']
p = yield AppProperty.find(
where=['application_id = ? AND port = ?', app.id, port],
limit=1)
if p is None:
abort(404,
message={'error': "Application property doesn't exist."})
kwargs = {}
for a, v in self.args.items():
if a not in {'name', 'type', 'port'}:
continue
if v is not None and v != getattr(p, a):
kwargs[a] = v
setattr(p, a, v)
(valid, message) = yield p.valid()
if not valid:
abort(400, message=message)
# Update the model
if kwargs:
p.update(**kwargs)
returnValue(({}, 200))
except TimeoutError:
log.error(
"REST API timeout put request for application {appeui} "
"property {port}",
appeui=euiString(appeui),
port=port)
def get(self, appeui):
"""Method to handle application GET requests
Args:
appeui (int): Application EUI
"""
try:
a = yield Application.find(where=['appeui = ?', appeui], limit=1)
# Return a 404 if not found.
if a is None:
abort(404,
message={
'error':
"Application {} doesn't exist.".format(
euiString(appeui))
})
data = marshal(a, self.fields)
data['properties'] = yield self.getProperties(a)
returnValue(data)
except TimeoutError:
log.error("REST API timeout retrieving application {appeui}",
appeui=euiString(appeui))
def delete(self, appeui):
"""Method to handle application property DELETE requests
Args:
appeui (int): application EUI
"""
try:
# Return a 404 if the application is not found.
app = yield Application.find(where=['appeui = ?', appeui], limit=1)
if app is None:
abort(404,
message={
'error':
"Application {} doesn't exist.".format(
euiString(appeui))
})
port = self.args['port']
# Return a 404 if the property is not found.
p = yield AppProperty.find(
where=['application_id = ? AND port = ?', app.id, port],
limit=1)
if p is None:
abort(404,
message={'error': "Application property doesn't exist."})
yield p.delete()
returnValue(({}, 200))
except TimeoutError:
log.error(
"REST API timeout retrieving application {appeui} "
"property {port}",
appeui=euiString(appeui),
port=port)
def inboundAppMessage(self, devaddr, appdata, acknowledge=False):
"""Sends inbound data from the application interface to the device
Args:
devaddr (int): 32 bit device address (DevAddr)
appdata (str): packed application data
acknowledge (bool): Acknowledged message
"""
log.info("Inbound message to devaddr {devaddr}",
devaddr=devaddrString(devaddr))
# Retrieve the active device
device = yield self._getActiveDevice(devaddr)
if device is None:
log.error("Cannot send to unregistered device address {devaddr}",
devaddr=devaddrString(devaddr))
returnValue(None)
# Check the device is enabled
if not device.enabled:
log.error(
"Inbound application message for disabled device "
"{deveui}",
deveui=euiString(device.deveui))
returnValue(None)
# Get the associated application
app = yield Application.find(where=['appeui = ?', device.appeui],
limit=1)
if app is None:
log.error(
"Inbound application message for {deveui} - "
"AppEUI {appeui} does not match any configured applications.",
deveui=euiString(device.deveui),
appeui=device.appeui)
returnValue(None)
# Find the gateway
gateway = self.lora.gateway(device.gw_addr)
if gateway is None:
log.error(
"Could not find gateway for inbound message to "
"{devaddr}.",
devaddr=devaddrString(device.devaddr))
returnValue(None)
# Increment fcntdown
fcntdown = device.fcntdown + 1
# Piggyback any queued MAC messages in fopts
fopts = ''
device.rx = self.band.rxparams((device.tx_chan, device.tx_datr),
join=False)
if self.config.macqueueing:
# Get all of this device's queued commands: this returns a list of tuples (index, command)
commands = [(i, c[2]) for i, c in enumerate(self.commands)
if device.deveui == c[1]]
for (index, command) in commands:
# Check if we can accommodate the command. If so, encode and remove from the queue
if self.band.checkAppPayloadLen(device.rx[1]['datr'],
len(fopts) + len(appdata)):
fopts += command.encode()
del self.commands[index]
else:
break
# Create the downlink message, encrypt with AppSKey and encode
response = MACDataDownlinkMessage(device.devaddr,
device.nwkskey,
device.fcntdown,
self.config.adrenable,
fopts,
int(app.fport),
appdata,
acknowledge=acknowledge)
response.encrypt(device.appskey)
data = response.encode()
# Create Txpk objects
txpk = self._txpkResponse(device,
data,
gateway,
itmst=int(device.tmst),
immediate=False)
request = GatewayMessage(version=2,
gatewayEUI=gateway.eui,
remote=(gateway.host, gateway.port))
# Save the frame count down
device.update(fcntdown=fcntdown)
# Send RX1 window message
self.lora.sendPullResponse(request, txpk[1])
# If Class A, send the RX2 window message
self.lora.sendPullResponse(request, txpk[2])
def processPushDataMessage(self, request, gateway):
"""Process a PUSH_DATA message from a LoraWAN gateway
Args:
request (GatewayMessage): the received gateway message object
gateway (Gateway): the gateway that sent the message
Returns:
True on success, otherwise False
"""
if not request.rxpk:
request.rxpk = []
for rxpk in request.rxpk:
# Decode the MAC message
message = MACMessage.decode(rxpk.data)
if message is None:
log.info(
"MAC message decode error for gateway {gateway}: message "
"timestamp {timestamp}",
gateway=gateway.host,
timestamp=str(rxpk.time))
returnValue(False)
# Check if thisis a duplicate message
if self._checkDuplicateMessage(message):
returnValue(False)
# Join Request
if message.isJoinRequest():
# Get the application using appeui
app = yield Application.find(
where=['appeui = ?', message.appeui], limit=1)
#app = next((a for a in self.applications if
# a.appeui == message.appeui), None)
if app is None:
log.info(
"Message from {deveui} - AppEUI {appeui} "
"does not match any configured applications.",
deveui=euiString(message.deveui),
appeui=message.appeui)
returnValue(False)
# Find the Device
device = yield Device.find(
where=['deveui = ?', message.deveui], limit=1)
if device is None:
#log.info("Message from unregistered device {deveui}",
# deveui=euiString(message.deveui))
#returnValue(False)
# TODO save device to database (cheng)
device = Device(deveui=message.deveui,
name='smk_node',
devclass='A',
enabled=True,
otaa=True,
devaddr=None,
devnonce=[],
appeui=message.appeui,
nwkskey='',
appskey='',
fcntup=0,
fcntdown=0,
fcnterror=False,
snr=[],
snr_average=0)
#device.save()
else:
# Check the device is enabled
if not device.enabled:
log.info("Join request for disabled device {deveui}.",
deveui=euiString(device.deveui))
returnValue(False)
# Process join request
joined = yield self._processJoinRequest(message, app, device)
if joined:
# Update the ADR measures
if self.config.adrenable:
device.updateSNR(rxpk.lsnr)
yield device.update(tx_chan=rxpk.chan,
tx_datr=rxpk.datr,
devaddr=device.devaddr,
nwkskey=device.nwkskey,
appskey=device.appskey,
time=rxpk.time,
tmst=rxpk.tmst,
gw_addr=gateway.host,
fcntup=0,
fcntdown=0,
fcnterror=False,
devnonce=device.devnonce,
snr=device.snr,
snr_average=device.snr_average)
log.info(
"Successful Join request from DevEUI {deveui} "
"for AppEUI {appeui} | Assigned address {devaddr}",
deveui=euiString(device.deveui),
appeui=euiString(app.appeui),
devaddr=devaddrString(device.devaddr))
# Send the join response
device.save()
self._sendJoinResponse(request, rxpk, gateway, app, device)
returnValue(True)
else:
log.info(
"Could not process join request from device "
"{deveui}.",
deveui=euiString(device.deveui))
returnValue(False)
# LoRa message. Check this is a registered device
device = yield self._getActiveDevice(message.payload.fhdr.devaddr)
if device is None:
log.info(
"Message from device using unregistered address "
"{devaddr}",
devaddr=devaddrString(message.payload.fhdr.devaddr))
returnValue(False)
# Check the device is enabled
if not device.enabled:
log.info("Message from disabled device {devaddr}",
devaddr=devaddrString(message.payload.fhdr.devaddr))
returnValue(False)
# Check frame counter
if not device.checkFrameCount(message.payload.fhdr.fcnt,
self.band.max_fcnt_gap,
self.config.fcrelaxed):
log.info("Message from {devaddr} failed frame count check.",
devaddr=devaddrString(message.payload.fhdr.devaddr))
log.debug(
"Received frame count {fcnt}, device frame count {dfcnt}",
fcnt=message.payload.fhdr.fcnt,
dfcnt=device.fcntup)
yield device.update(fcntup=device.fcntup,
fcntdown=device.fcntdown,
fcnterror=device.fcnterror)
returnValue(False)
# Perform message integrity check.
if not message.checkMIC(device.nwkskey):
log.info(
"Message from {devaddr} failed message "
"integrity check.",
devaddr=devaddrString(message.payload.fhdr.devaddr))
returnValue(False)
# Update SNR reading and device
device.updateSNR(rxpk.lsnr)
yield device.update(tx_chan=rxpk.chan,
tx_datr=rxpk.datr,
fcntup=device.fcntup,
fcntdown=device.fcntdown,
fcnterror=device.fcnterror,
time=rxpk.time,
tmst=rxpk.tmst,
adr=bool(message.payload.fhdr.adr),
snr=device.snr,
snr_average=device.snr_average,
gw_addr=gateway.host)
# Set the device rx window parameters
device.rx = self.band.rxparams((device.tx_chan, device.tx_datr),
join=False)
# Process MAC Commands
commands = []
# Standalone MAC command
if message.isMACCommand():
message.decrypt(device.nwkskey)
commands = [MACCommand.decode(message.payload.frmpayload)]
# Contains piggybacked MAC command(s)
elif message.hasMACCommands():
commands = message.commands
for command in commands:
if command.isLinkCheckReq():
self._processLinkCheckReq(device, command, request,
rxpk.lsnr)
elif command.isLinkADRAns():
self._processLinkADRAns(device, command)
# TODO: add other MAC commands
# Process application data message
if message.isUnconfirmedDataUp() or message.isConfirmedDataUp():
# Find the app
app = yield Application.find(
where=['appeui = ?', device.appeui], limit=1)
if app is None:
log.info(
"Message from {devaddr} - AppEUI {appeui} "
"does not match any configured applications.",
devaddr=euiString(device.devaddr),
appeui=device.appeui)
returnValue(False)
# Decrypt frmpayload
message.decrypt(device.appskey)
appdata = str(message.payload.frmpayload)
port = message.payload.fport
# Route the data to an application server via the configured interface
log.info("Outbound message from devaddr {devaddr}",
devaddr=devaddrString(device.devaddr))
interface = interfaceManager.getInterface(app.appinterface_id)
if interface is None:
log.error(
"No outbound interface found for application "
"{app}",
app=app.name)
elif not interface.started:
log.error(
"Outbound interface for application "
"{app} is not started",
app=app.name)
else:
self._outboundAppMessage(interface, device, app, port,
appdata)
# Send an ACK if required
if message.isConfirmedDataUp():
yield self.inboundAppMessage(device.devaddr,
'',
acknowledge=True)