Miataru - be found

iOS App

The Miataru iOS app is available in the iOS AppStore. Click on the below badge to download it!

Android App

The Miataru Android App is under development. You can access the source-code repository here.

There's no public release yet.

HTML5 WebClient Application

The HTML5 Webclient Application is currently under development. The current work-in-progress state can be viewed here:

You can also embed it anywhere you want:

SailfishOS Client

Dr. Andreas Heil took on the task of creating an SailfishOS version of the Miataru client. You can get the current code here:

The reference Implementation of the Miataru server is done using Node.JS and Redis and will be released as under the 2-clause BSD license. Find more information and a download link at the GitHub pages.

Current Build Status:

• A server that stores location data (sent in using JSON and a HTTP POST request) for a given amount of seconds
• After the pre-configured amount of seconds the location data for a user is "forgotten"
• A server that makes available a given amount of location history, if the user wants that (not by default)
• A server that offers through simple GET requests the location of a particular device and eventually a location history of configurable length/duration
• The server component will be released as open source software – the protocol itself will be documented so that any self-written server can be used as well

/v1/UpdateLocation

This method is used to update the location of a device. The device does not need to be known already to the Miataru server but it rather creates a unique identifier for itself in the client application. This unique identifier, or device ID is then used to address this particular device.

Example:

{
    "MiataruConfig": {
        "EnableLocationHistory": "False",
        "LocationDataRetentionTime": "15"
    },
    "MiataruLocation": [
        {
            "Device": "7b8e6e0ee5296db345162dc2ef652c1350761823",
            "Timestamp": "1376735651302",
            "Longitude": "10.837502",
            "Latitude": "49.828925",
            "HorizontalAccuracy": "50.00"
        }
    ]
}
				

The data structure allows to post multiple location updates in one request, even for multiple devices.

The server will response with a simple response message:

{
	"MiataruResponse":"ACK", 
	"MiataruVerboseResponse":"><)))x>"
}
				

The response can be ACK or NACK - if there's a NACK you got a more verbose error description in the MiataruVerboseResponse field. If it's ACK you got a nice fish there.

/v1/GetLocation

To retrieve a specific devices latest known location the /GetLocation method is used. Please note that the MiataruConfig portion is optional. RequestMiataruDeviceID should be the ID of the device the request is sent from (or an identifier like an URL).

Example Request:

{
    "MiataruConfig": 
    {
        "RequestMiataruDeviceID": "6140c3c0-4a7d-40d2-99ab-39414cac3509"
    },
    "MiataruGetLocation": [
        {
            "Device": "7b8e6e0ee5296db345162dc2ef652c1350761823"
        }
    ]
}
				

By adding more devices to the array you get the locations of multiple devices in one request.

Example Response:

{
    "MiataruLocation": [
        {
            "Device": "7b8e6e0ee5296db345162dc2ef652c1350761823",
            "Timestamp": "1376735651302",
            "Longitude": "10.837502",
            "Latitude": "49.828925",
            "HorizontalAccuracy": "50.00"
        }
    ]
}
				

If there's no known location data for a device the server will report back with a filled MiataruNoLocation array.

/v1/GetLocationHistory

Location History is stored on the server only if the client told the server to do so using the “EnableLocationHistory” setting in the Location Update requests. For transitions of enabling/disabling that functionality: Everytime a Location Update is received by the server with “EnableLocationHistory=false” the server removes all stored Location History till that point.

There is a server-side setting that controls up to how many Location Updates the server is storing in the Location History before it removes the oldest one.

To request the Location History of a particular device the client sends the following POST request to the GetLocationHistory service URL. Please note that the MiataruConfig portion is optional. RequestMiataruDeviceID should be the ID of the device the request is sent from (or an identifier like an URL).

Example Request:

{   "MiataruConfig": 
    {
        "RequestMiataruDeviceID": "6140c3c0-4a7d-40d2-99ab-39414cac3509"
    },
    "MiataruGetLocationHistory": {
        "Device": "7b8e6e0ee5296db345162dc2ef652c1350761823",
        "Amount": "25"
    }
}
				

The server will answer back with an Array of LocationUpdates if there are Location Updates, or a List of NoLocations when there are none. If the client requested more Location Updates than there are available the server will return those available.

Example Response:

{
    "MiataruServerConfig": {
        "MaximumNumberOfLocationUpdates": "1000",
        "AvailableDeviceLocationUpdates": "25"
    },
    "MiataruLocation": [
        {
            "Device": "7b8e6e0ee5296db345162dc2ef652c1350761823",
            "Timestamp": "1376735651302",
            "Longitude": "10.837502",
            "Latitude": "49.828925",
            "HorizontalAccuracy": "50.00"
        },
        {
            "Device": "7b8e6e0ee5296db345162dc2ef652c1350761823",
            "Timestamp": "1376737022853",
            "Longitude": "10.937502",
            "Latitude": "49.858925",
            "HorizontalAccuracy": "5.00"
        }
    ]
}				
				

If there's no known location data for a device the server will report back with a MiataruNoLocation array instead of a MiataruLocation array.

/v1/GetVisitorHistory

Visitor History is stored on the server with every request to the location or location history information of a device.

There is a server-side setting that controls up to how many Visitors the server is storing in the Visitor History before it removes the oldest one.

To request the Visitor History of a particular device the client sends the following POST request to the GetVisitorHistory service URL.

Example Request:

{
    "MiataruGetVisitorHistory": {
        "Device": "7b8e6e0ee5296db345162dc2ef652c1350761823",
        "Amount": "25"
    }
}
				

The server will answer back with an Array of MiataruVisitors if there are Visitors, or an empty list when there are none. If the client requested more Visitor Updates than there are available the server will return those available.

Example Response:

{
    "MiataruServerConfig": {
        "MaximumNumberOfVisitorHistory": "10",
        "AvailableVisitorHistory": "2"
    },
    "MiataruVisitors": [
        {
            "DeviceID": "7b8e6e0ee5296db345162dc2ef652c1350761823",
            "TimeStamp": "1437683462"
        },
        {
            "DeviceID": "7b8e6e0ee5296db345162dc2ef652c1350761823",
            "TimeStamp": "1437683462"
        }
    ]
}				
				

If there's no known location data for a device the server will report back with a MiataruNoLocation array instead of a MiataruLocation array.