A python library to add ans search observations into flythings
Project description
FlyThings Client
Getting Started
To use this client is necesary:
$ pip install flythings
And now start to test the flythings clients.
Documentation
Configuration File
The general properties configuration in Configuration.properties:
- user: (Optional) user email or identifier to login on the system.
- password: (Optional) the user password to login, is not recommended use this configuration.
- server: (Optional, Default beta.flythings.io/api) configure the server url to insert the data.
- token: (Optional) the user token to send data into flythings plataform.
- device: (Optional) the device which sends data.
- sensor: (Optional) the sensor wich sends data.
- login_type: (Optional) type of login to use.
- timeout: (Optional) request timeout in seconds.
- Example of configuration file
SERVER:beta.flythings.io/api
USER:<put your username here>
PASSWORD:<put your password here>
DEVICE:Python
SENSOR:Client
LOGIN_TYPE:USER or DEVICE
TIMEOUT: 1000
To load the data from the file call this function:
- loadDataByFile(String file)
Description: Loads data from the file.
Return: Nothing.
Examples:
- Loads config data from a file.
PYTHON import flythings as fly fly.loadDataByFile("/home/xxxx/configuration.properties")
You can also introduce this general properties using the library methods.
General Module Configuration Methods
-
setServer(String server)
Description: Sets the server to which the requests will be sent.
Return: Returns a string representing the server. -
setDevice(String device, (Optional) object=None)
Params:
- device: (Mandatory) Device name.
- object: (Optional) Object with extra device params.object = { "type": "CUSTOM", "geom": { "type": "Point", "crs": "4326", "coordinates": [ -19.323204, 27.611808 ] } }
Description: Sets the device of the observation. Uses a file named .foiCache to get a fast access to most used devices.
Return: Returns a string representing the device. -
setSensor(String sensor)
Description: Sets the sensor of the observation.
Return: Returns a string representing the sensor. -
setToken(String token)
Description: Sets the token to authenticate into the server.
Return: Returns a string representing the token. -
setCustomHeader(String header, String header_value)
Description: Sets a custom header for server requests.
Return: Returns a string representing the header. -
getHeaders(String header, String header_value)
Description: Return current headers.
Return: Return current headers. -
setTimeout(int timeout)
Description: Sets the timeout value in seconds to the server requests.
Return: Returns a integer representing the timeout. -
login(String user, String password, String login_type ['USER' or 'DEVICE])
Description: Authenticate against the server.
Return: Returns a string representing the token or None if login fails.
Modules documentation
Tests
In the test folder, after fill in the Configuration.Properties file write on bash:
nosetests flythingsTest.py
(Nose python library is needed)
Change log
License
Developed by ITG
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.