Metadata-Version: 2.1
Name: flythings
Version: 1.4.15
Summary: A python library to add ans search observations into flythings
Home-page: https://github.com/flythings/python
Author: flythings
Author-email: tic@itg.es
License: GPL-3.0
Download-URL: https://github.com/flythings/python/1.4.15.tar.gz
Description: 
        # [FlyThings Client](http://flythings.io) 
        ## Getting Started  
          
        To use this client is necesary:  
        *  Install [Python](https://www.python.org/) (>=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3*) 
        * Install [pip](https://pypi.python.org/pypi/pip?)  
        * To Install our library:  
        ```BASH  
            $ 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  
        ```JSON  
            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.  
            ```PYTHON
          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
        - [InsertionModule](docs/InsertionModule.md)
        - [RealTimeModule](docs/RealTimeModule.md)
        - [ActionModule](docs/ActionModule.md)     
        - [UtilModule](docs/UtilModule.md)     
          
        ### Tests  
        In the test folder, after fill in the Configuration.Properties file write on bash:  
          
        ```BASH  
            nosetests flythingsTest.py  
        ```  
        ([Nose python library is needed](http://nose.readthedocs.io/en/latest/))
        
        
        ### Change log
           - [Change log](changelog.md) 
        
        ## [License](LICENSE)
        **Developed by [ITG](http://www.itg.es)**
        
         
Keywords: flythings,IoT
Platform: UNKNOWN
Description-Content-Type: text/markdown
