Skip to content

Commit

Permalink
Merge branch 'development' of github.com:hotosm/fmtm into fix/geom-to…
Browse files Browse the repository at this point in the history
…-geojson
  • Loading branch information
Sujanadh committed Jan 10, 2025
2 parents 2758f38 + 056c3b5 commit 22f0fee
Show file tree
Hide file tree
Showing 22 changed files with 573 additions and 322 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ pre-commit install
- In order to commit to this repository, please read and accept our
[commit sign-off policy](https://developercertificate.org)
- This is simply to verify that you are the author of the commits you make.
- If possible, please add to your commit footer the `Signed-of-by` info:
- If possible, please add to your commit footer the `Signed-off-by` info:
`Signed-off-by: John Doe <[email protected]>`

## Our Development Practices
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ the FMTM aims to solve the problem of **coordinating** field mapping campaigns.
This project relies heavily on the [ODK](getodk.org) ecosystem underneath:

- [XLSForms](https://xlsform.org) are used for the underlying data collection
survey. The fields in this survey can be mapped to OpenStreeMap tags.
survey. The fields in this survey can be mapped to OpenStreetMap tags.
- [ODK Central](https://github.com/getodk/central) is used to store the XLSForm
and receive data submissions from users.
- [ODK Collect](https://github.com/getodk/collect) is a mobile app that the user
Expand Down
128 changes: 0 additions & 128 deletions docs/about/FMTM Field Mapping Guidelines.md

This file was deleted.

27 changes: 0 additions & 27 deletions docs/manuals/OData Connection for Submission Analysis

This file was deleted.

80 changes: 78 additions & 2 deletions docs/manuals/mapping.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,36 @@
The **Mapper Frontend** was developed to provide a simpler, more intuitive
mapping experience.

## Prerequisites

### Device Requirements

Ensure you have an Android device for field mapping activities, as ODK is
not supported on iOS devices.

Verify that your mobile device meets the minimum specifications required
for field mapping:

- Minimum RAM: 4GB
- Storage: Ensure sufficient storage space is available (1GB should be enough).
- Operating System: ODK recommends using Android 10 or higher for
the best security and performance.

#### Checking Device Specifications

- Go to the file manager or "My Files" on your mobile device to see
the device storage.
- Check your phone settings for information about device settings
such as RAM and processors.

### Browser Selection

- We recommend using the Chrome browser on your mobile device to access
the FMTM platform for optimal performance.
- If you encounter difficulties using FMTM through the browser, you can
add the FMTM browser shortcut to your home screen via the menu.
![image](https://github.com/user-attachments/assets/03bd53fb-3879-4a11-a98e-6c8e2651210a)

## Part (A): Setup For Mapping

### Step 1: Install The Custom ODK Collect Mobile App
Expand All @@ -11,6 +41,9 @@ mapping experience.
the custom `.apk` from the sidebar.
- Once downloaded, you should install the custom ODK Collect application.

![highlighted-sidebar](https://github.com/user-attachments/assets/53de2d80-2709-45b0-bb82-32f0190c7859)
![download-custom-odk](https://github.com/user-attachments/assets/22501751-4962-4cd7-ace1-7587269ae16c)

!!! tip

If you already have ODK Collect installed, you may have to uninstall
Expand All @@ -32,6 +65,13 @@ mapping experience.
This functionality is designed for mappers in the field, so it is
recommended to use a mobile device to access it.

!!! warning

Here you may log into the website to be attributed with you edits.

If you do not log in, a generic account will be used to record your
edits and data collection.

### Step 3: Configure ODK Collect (once only)

- **Option 1:** Scan the QR code displayed on the Mapper Frontend using
Expand All @@ -53,18 +93,34 @@ mapping experience.

### Step 4: Load Imagery (optional)

- You can load the reference base imagery by clicking on offline mode option
- You can load the base imagery by clicking on offline mode option
(second tab on bottom navigation bar).
- Choose the layer you want to load and click on **Show on Map** to visualise
the layer on map.
- The layer can also be stored for offline mapping by clicking
**Store Offline**.

![offline-pmtiles](https://github.com/user-attachments/assets/1c091df2-2db0-4546-b600-e2a3a339b981)

!!! tip

This step should probably be done prior to leaving for the field!

The files can be a few 100MB in size.

MBTiles are used for loading into ODK Collect.
PMTiles are used for navigating in FMTM.

If you encounter issues with the base imagery, contact your project
manager.

## Part (B): Mapping Features

Before starting to map features, ensure that geolocation is enabled.
This will allow you to access your live location, making navigation easier.

You may either map an **existing feature** OR map a **new feature**.

### Select An Existing Feature

In most cases we are submitting a survey about a feature that already exists.
Expand All @@ -75,13 +131,21 @@ In most cases we are submitting a survey about a feature that already exists.
feature pre-selected in the survey (no need to open the ODK map!).
- Complete the survey and submit.

!!! note
!!! tip

You may manually click 'Start Mapping' for a task area.

However, the task will be automatically locked for you
if you map a feature within the task area.

!!! note

The task area will change colour based on it's status.

The legend explaining these colours can be opened on the map:

![legend](https://github.com/user-attachments/assets/280fd927-b71e-4336-a89a-1672e8de687b)

### Mapping A New Feature

Sometimes the feature does not exist on the map yet!
Expand All @@ -92,12 +156,24 @@ Sometimes the feature does not exist on the map yet!
- ODK Collect will be opened automatically to fill out the survey
data for the newly created feature.

!!! note

The task area will change colour based on it's status.

Consult the project manager to determine if the feature should be a
polygon (drawing all corners of the feature in ODK) or point
(collecting only the GPS point of the feature).

Confirm the exact point (gate location, right corner, center of the
building) and GPS accuracy required for consistency and quality data.

### Repeat The Process

- Once the form is submitted, you have to get back to FMTM and select the
another feature for mapping.
- You also also have to click the **Sync Status** button to see the feature
turn green.
![sync-status-button](https://github.com/user-attachments/assets/38062aad-c8ea-4d47-a617-4be70dbfa20c)
- Select another feature to map (repeat from step 5)!

!!! note
Expand Down
Loading

0 comments on commit 22f0fee

Please sign in to comment.