[Implemented] iDevices (iphone/ipad) location plugin

---

Now we have a great location service for android http://forum.pimatic.org/topic/23/plugin-pimatic-location-rules-based-on-location/4
Do we have some volunteers to do the same for Iphone/Ipad, there is a nodejs for that https://github.com/drudge/node-sosumi

I think that having something compliant with what @Oitzu did already on Android could also do the trick much better than something totally new for iDevices (so that would mean that only a Iphone/Ipad app could be necessary)

Updating the location-plugin is as easy as sending a http(s) request with the following schema to the pimatic API:

http(s)://<hostname>:<port>/api/device/<device-id>/updateLocation?lat=<latitude>&long=<longitude>&updateAddress=[0|1]

The rest of the work (calculating distances) does do the plugin.

So if there is an iOS Developer out there, willing to do this, this should be easy.

The referenced nodjs-module do it the other way arround. It gets the iOS Device Location by using Apples ‘find my iPhone’-Service.
I don’t know how well this Service works but this would be possible to implement directly in the plugin.
Unfortunately the referenced module is, according to the issues, hopeless outdated.

Ok this app should do the trick then https://itunes.apple.com/fr/app/sendlocation/id377724446?mt=8
let’s try…

Seems to work fine with that app
Simply use this kind of address then
https://login:password@hostname:port/api/device/device-id/updateLocation?lat=48.00&long=2.00&updateAddress=1

On the other hand i fail with gmaps api:

1. i activated all maps API + Directions one
2. into credential i created a API key linked to my pimatic external ip address
3. added they key into pimatic conf

I get this error then:

23:21:47.141 [pimatic-location] debug: Received: long=2;2764276 lat=47.76,46.761872 updateAddress=1 from TelYves
23:21:47.395 [pimatic-location] error: Didn't received correct Gmaps-Api response!
23:21:47.398 [pimatic-location] debug: Gmaps-Api response: {
23:21:47.398 [pimatic-location] debug:>   "routes" : [],
23:21:47.398 [pimatic-location] debug:>   "status" : "NOT_FOUND"
23:21:47.398 [pimatic-location] debug:>}
23:21:47.398 [pimatic-location] debug:>

PLS DON’T RUSH and buy this app there is maybe a problem with the way that it send location…

@Oitzu ok i understand now how SendLocation application works
if i configure the app like this

http://hostname:port/api/device/555/updateLocation?lat=lat&long=1&updateAddress=1

Here is what the app will send

GET /api/device/555/updateLocation?lat=lat&long=1&updateAddress=1&lat=48.943315&lon=2.340530&speed=0.000000&heading=356.835938&vacc=4.000000&hacc=10.000000&altitude=69.626919&deviceid=FFFFFFFF87F HTTP/1.1

So as you can see the app will only append "lat=lat&long=1&updateAddress=1"
to the others built-in parameters ie : “&lat=48.943315&lon=2.340530&speed=0.000000&heading=356.835938&vacc=4.000000&hacc=10.000000&altitude=69.626919&deviceid=FFFFFFFF87F”

So to make this works, i need to configure the app with this URL

http://hostname:port/api/device/555/updateLocation?updateAddress=1

that will give

GET /api/device/555/updateLocation?updateAddress=1&lat=48.943315&lon=2.340530&speed=0.000000&heading=356.835938&vacc=4.000000&hacc=10.000000&altitude=69.626919&deviceid=FFFFFFFF87F HTTP/1.1

And on your side @Oitzu could you just make your module understand parameter lon (in addition to the long that already exist in your plugin)?

EDIT: for testing purpose i have just replaced every occurrences of long by lon into pimatic-location.coffee and it’s working fine

Today i went out to walk a bit and pimatic saw that

Pls note that i you go for the SendLocation app https://itunes.apple.com/fr/app/sendlocation/id377724446?mt=8
You will need to replace every occurrences of long by lon into pimatic-location.coffee (until @Oitzu do the appropriate change)

@Yves911 I can’t get it to work.

sendlocation url:

http://admin:password@server.wiebenieuwenhuis.nl/api/device/your-phone/updateLocation?updateAddress=1

device:

{
      "id": "your-phone",
      "name": "your-phone",
      "class": "LocationDevice",
      "lat": 52.302646,
      "long": 6.841062
    },

and i replaced all long to lon in pimatic-location.cofffee

@sweebee
Could you check that the file is the same:
more pimatic-location.coffee

module.exports = (env) ->
  # Require the  bluebird promise library
  Promise = env.require 'bluebird'

  # Require the [cassert library](https://github.com/rhoot/cassert).
  assert = env.require 'cassert'

  gmaputil = require 'googlemapsutil-https'
  geolib = require 'geolib'
  
  # ###PimaticLocation class
  class PimaticLocation extends env.plugins.Plugin

    # #####params:
    #  * `app` is the [express] instance the framework is using.
    #  * `framework` the framework itself
    #  * `config` the properties the user specified as config for your plugin in the `plugins` 
    #     section of the config.json file 
    #     
    # 
    init: (app, @framework, @config) =>
      deviceConfigDef = require("./device-config-schema")
      @framework.deviceManager.registerDeviceClass("LocationDevice", {
        configDef: deviceConfigDef.LocationDevice,
        createCallback: (config) => new LocationDevice(config)
      })

    
  class LocationDevice extends env.devices.Device
        
    actions:
      updateLocation:
        description: "Updates the location of the Device."
        params:
          lon:
            type: "number"
          lat:
            type: "number"
          updateAddress:
            type: "number"
        
    constructor: (@config) ->
      @name = config.name
      @id = config.id
      @pimaticLat = config.lat
      @pimaticLong = config.long
      @useMaps = config.useGoogleMaps
      @apiKey = config.googleMapsApiKey

      @attributes = {
        linearDistance:
          label: "Linear Distance"
          description: "Linear distance between the devices."
          type: "number"
          unit: "m"
          acronym: 'DIST'
      }

      if @useMaps
        @attributes.routeDistance = {
          label: "Route Distance"
          description: "Distance between the devices by road."
          type: "number"
          unit: "m"
          acronym: 'ROAD'
        }
        @attributes.eta = {
          label: "ETA"
          description: "Estimated time of arrival."
          type: "number"
          unit: "s"
          acronym: 'ETA'
        }
        @attributes.address = {
          label: "Address"
          description: "Current Address."
          type: "string"
          acronym: 'ADRS'
        }

      super()

    getLinearDistance: -> Promise.resolve(@_linearDistance)
    getRouteDistance: -> Promise.resolve(@_routeDistance)
    getEta: -> Promise.resolve(@_eta)
    getAddress: -> Promise.resolve(@_address)

    updateLocation: (lon, lat, updateAddress) ->
      start_loc = {
        lat: lat
        lng: lon
      }
      end_loc = {
        lat: @pimaticLat
        lng: @pimaticLong
      }
      
      env.logger.debug(
        "Received: long=#{lon} lat=#{lat} updateAddress=#{updateAddress} from #{@name}"
      )
      
      linearDistance = geolib.getDistance(start_loc, end_loc)
     
      @_linearDistance = linearDistance
      @emit 'linearDistance', @_linearDistance

      if @useMaps is true
        options = {}
        use_ssl = false
        if @apiKey isnt "0"
          use_ssl = true
          options = {
            key: @apiKey
          }

        updateLocationCB = (err, result) =>
          if err
            env.logger.error(err)
          else
            try
              data = JSON.parse result
              route_distance = data['routes'][0]['legs'][0]['distance']['value']
              eta = data['routes'][0]['legs'][0]['duration']['value']
              address = data['routes'][0]['legs'][0]['start_address']
            
              @_routeDistance = route_distance
              @_eta = eta
          
              @emit 'routeDistance', route_distance
              @emit 'eta', eta
              if updateAddress is 1
                @_address = address
                @emit 'address', @_address
              else
                @_address = '-'
                @emit 'address', @_address
            catch error
              env.logger.error("Didn't received correct Gmaps-Api response!")
              env.logger.debug("Gmaps-Api response: "+result)
          return  
        
        gmaputil.directions(start_loc, end_loc, options, updateLocationCB, true, use_ssl)

      return Promise.resolve()
    
  # ###Finally
  # Create a instance of my plugin
  pimaticLocation = new PimaticLocation
  # and return it to the framework.
  return pimaticLocation

and here my config

    {
      "id": "555",
      "name": "WhereAmI",
      "class": "LocationDevice",
      "lat": 48.656733,
      "long": 2.3260445,
      "useGoogleMaps": true,
      "googleMapsApiKey": "xxxxxxxxx"
    },

The best option is that you copy over pimatic-location.cofffee.

Another thing are you really using http or https? In your config it’s http.

Its working now but i can’t get the maps api to work?

Didn’t received correct Gmaps-Api response!

@sweebee
Could you pls do the following:

1. stop pimatic
2. sudo nc -vv -l -p 80
3. close/reopen the app on your phone

It should display someting like

GET /api/device/555/updateLocation?updateAddress=1&lat=48.943315&lon=2.340530&speed=0.000000&heading=356.835938&vacc=4.000000&hacc=10.000000&altitude=69.626919&deviceid=FFFFFFFF87F HTTP/1.1

if yes all good you can ctrl-c and restart pimatic.

Do you receive the same error than i in post http://forum.pimatic.org/topic/203/idevices-iphone-ipad-location-plugin/4# ?

@Yves911

18:54:24.653 [pimatic-location] debug:>   "error_message" : "This IP, site or mobile application is not authorized to use this API key.",
18:54:24.653 [pimatic-location] debug:>   "routes" : [],
18:54:24.653 [pimatic-location] debug:>   "status" : "REQUEST_DENIED"
18:54:24.653 [pimatic-location] debug:>}

I used Key for server applications and entered the ip

@sweebee i am not an expert in this google API things.
I did the same as you key for server applications and entered my public IP (did you enter your public IP and not a local one?)

@Yves911 I used the external ip, where i can reach pimatic from outside by house.

so maybe you need to wait a bit then?
did you registered for the Directions API?

@Yves911 yes, i had to wait i think. Its working now

Very good!!!
If your xp with this app is OK
and if @Oitzu update the plugin then we will be able to tag this feature as implemented

@Yves911 maybe you can write a short instruction/ hand out/ summarize how to get the plugin working with an iPhone?!

This is what I did:

Install pimatic-location.
go to your pimatic folder > pimatic-app/node_modules/pimatic-location

Edit pimatic-location.coffee and replace all ‘long’ by 'lon’
Edit device-config-schema.coffee and replace all 'long by ‘lon’

Add your location device: (replace lat/lon with your home coordinates)

{
      "id": "your-phone",
      "name": "Your Phone",
      "class": "LocationDevice",
      "lat": 52.00,
      "lon": 6.00
    },

Install ‘SendLocation’ iphone app. and click on the ‘i’ right bottom and add this url:

https://username:password@yourIp/api/device/your-phone/updateLocation?&updateAddress=1

And your Done!

Will look into this as soon I’m back from Egypt. (weekend)

@sweebee , thanks. It is almost working, I guess.
After the steps you mentioned I used ‘sudo nc -vv -l -p 80’ to check if there is a connection. And I get a result like Yves911 described earlier
But, after starting Pimatic my location-device gives no data:
DIST unknown m ROAD unknown m ETA unknown ADRS unknown.

What could be wrong?