pub package gitHub license

Overview

The at_location_flutter package is for Flutter developers who want to implement location feature in their apps. This package provides the feature to share and receive location between two atsigns.

This open source package is written in Dart, supports Flutter and follows the @‎platform's decentralized, edge computing model with the following features:

  • Cryptographic control of data access through personal data stores
  • No application backend needed
  • End to end encryption where only the data owner has the keys
  • Private and surveillance free connectivity
  • Share locations and view them on map

We call giving people control of access to their data “flipping the internet” and you can learn more about how it works by reading this overview.

Get Started:

There are three options to get started using this package.

1. Quick start - generate a skeleton app with at_app

This package includes a working sample application in the Example directory that you can use to create a personalized copy using at_app create in four commands.

$ flutter pub global activate at_app 
$ at_app create --sample=<package ID> <app name> 
$ cd <app name>
$ flutter run

Notes:

  1. You only need to run flutter pub global activate once
  2. Use at_app.bat for Windows

2. Clone it from GitHub

Feel free to fork a copy of the source from the GitHub repo. The example code contained there is the same as the template that is used by at_app above.

$ git clone https://github.com/atsign-foundation/at_widgets.git

3. Manually add the package to a project

Instructions on how to manually add this package to you project can be found on pub.dev here.

How it works

Setup

Initialising:

It is expected that the app will first authenticate an atsign using the Onboarding widget.

The location service needs to be initialised with a required GlobalKey

await initializeLocationService(
      navKey,
      mapKey: 'xxxx',
      apiKey: 'xxxx',
      showDialogBox: true,
      streamAlternative: (__){},
      isEventInUse: true, 
    );

As this package needs location permission, so add these for:

IOS: (ios/Runner/Info.plist)

<key>NSLocationWhenInUseUsageDescription</key>
<string>Explain the description here.</string>

Android: (android/app/src/main/AndroidManifest.xml)

<uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />
<uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" />

Usage

To share location with an atsign for 30 minutes:

sendShareLocationNotification(receiver, 30);

To request location from an atsign:

sendRequestLocationNotification(receiver);

To view location of atsigns:

AtLocationFlutterPlugin(
  ['atsign1', 'atsign2', ...]
)

To use the default map view:

Navigator.push(
      context,
      MaterialPageRoute(
          builder: (context) => MapScreen(
                currentAtSign: AtLocationNotificationListener().currentAtSign,
                userListenerKeyword: locationNotificationModel,
              )),
    );

To use the default home screen view:

Navigator.push(
      context,
      MaterialPageRoute(
        builder: (BuildContext context) => HomeScreen(),
    ));

Different datatypes used in the package:

 - LocationNotificationModel: Contains the details of a share/request location and is sent to atsigns while sharing / requesting.
 - LocationDataModel: Gets transferred in the background, contains the actual geo-coordinates and other details.
 - KeyLocationModel - The package uses this to keep a track of all the share/request notifications.

Steps to get mapKey

Steps to get apiKey

Example

We have a good example with explanation in the at_location_flutter package.

Open source usage and contributions

This is open source code, so feel free to use it as is, suggest changes or enhancements or create your own version. See CONTRIBUTING.md for detailed guidance on how to setup tools, tests and make a pull request.

Libraries

anim_type
api_service
at_location_flutter
A library to provide location sharing functionality used by the at_protocol packages and apps
at_location_flutter_plugin
at_location_notification_listener
bottom_sheet
bounds
build_marker
center_zoom
circle_layer
circle_marker_painter
collapsed_content
colors
confirmation_dialog
constants
contact_service
contacts_initial
This is a widget to display the initials of an atsign which does not have a profile picture it takes in @param size as a double and @param initials as String and display those initials in a circular avatar with random colors
crs
custom_circle_avatar
custom_popup_route
custom_toast
display_tile
distance_calculate
distance_grid
draggable_symbol
floating_icon
flutter_map
flutter_map_state
gestures
group_layer
home_screen
home_screen_service
hybrid_model
init_location_service
key_location_model
key_stream_service
latlng_bounds
latlng_tween
layer
loading_widget
location_data_model
location_modal
location_notification
location_prompt_dialog
location_service
map
map_screen
map_state_widget
marker_cluster
marker_cluster_layer
marker_cluster_layer_options
marker_cluster_node
marker_cluster_plugin
marker_custom_painter
marker_layer
marker_node
marker_popup
master_location_service
my_location
notification_dialog
notify_and_put
overlay_image_layer
plugin
point
pointed_bottom
polygon_layer
polyline_layer
pop_button
quick_hull
request_location_service
request_location_sheet
search_location_service
send_location_notification
share_location_sheet
sharing_location_service
show_location
spiderfy
tasks
text_strings
text_styles
text_tile
text_tile_repeater
tile_layer
tile_provider
util