You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/howto/customapp.md
+4-15Lines changed: 4 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,23 +2,12 @@
2
2
3
3
<PublicImagesrc="input.svg" />
4
4
5
-
The [Input app](https://inputapp.io/) is a great companion to Mergin as it
6
-
provides seamless synchronisation of data between your phone/tablet and
7
-
Mergin service. We know that sometimes people want a mobile app optimised
8
-
for a specific use case rather than just using a general purpose app like Input.
5
+
The [Input app](https://inputapp.io/) is a great companion to Mergin as it provides seamless synchronisation of data between your phone/tablet and Mergin service. We know that sometimes people want a mobile app optimised for a specific use case rather than just using a general purpose app like Input.
9
6
10
-
The good news is that Input is licensed as open source software and therefore
11
-
it is possible to build custom apps off it. Maybe you just want to change the
12
-
branding or disable some functionality - or maybe you want a bigger overhaul
13
-
of the user interface - anything is possible with a bit of development.
7
+
The good news is that Input is licensed as open source software and therefore it is possible to build custom apps off it. Maybe you just want to change the branding or disable some functionality - or maybe you want a bigger overhaul of the user interface - anything is possible with a bit of development.
14
8
15
9
## GitHub
16
10
17
-
If you are interested in building a custom app, you can start by going to
18
-
<GitHubRepoid="lutraconsulting/input"desc="Input App repository" /> on GitHub and
19
-
building it for your platform.
20
-
The <GitHubRepoid="lutraconsulting/input-sdk"desc="Input SDK repository" />
21
-
provides all the dependencies for various platforms (Android, iOS, macOS, Windows).
11
+
If you are interested in building a custom app, you can start by going to <GitHubRepoid="lutraconsulting/input"desc="Input App repository" /> on GitHub and building it for your platform. The <GitHubRepoid="lutraconsulting/input-sdk"desc="Input SDK repository" /> provides all the dependencies for various platforms (Android, iOS, macOS, Windows).
22
12
23
-
For the Input source code and developers' documentation, you can visit
24
-
<GitHubRepoid="lutraconsulting/input" />.
13
+
For the Input source code and developers' documentation, you can visit <GitHubRepoid="lutraconsulting/input" />.
Integrating with other databases is an important feature provided by the DB sync tool,
4
-
hosted in <GitHubRepoid="lutraconsulting/mergin-db-sync" />
5
-
repository. It takes care of synchronisation of changes between a Mergin project and a PostgreSQL
6
-
database. The synchronisation works both ways: it pushes changes from PostgreSQL to Mergin and
7
-
it also pulls changes from Mergin to PostgreSQL. Please see the project page for more details.
8
-
3
+
Integrating with other databases is an important feature provided by the DB sync tool, hosted in <GitHubRepoid="lutraconsulting/mergin-db-sync" /> repository. It takes care of synchronisation of changes between a Mergin project and a PostgreSQL database. The synchronisation works both ways: it pushes changes from PostgreSQL to Mergin and it also pulls changes from Mergin to PostgreSQL. Please see the project page for more details.
Note that **location tags have to be allowed** in a camera settings. You can find the option as following:
19
21
20
-
## Android
22
+
###Android
21
23
Open Camera app -> Camera settings -> Location tags.
22
24
23
25
24
-
## iOS
26
+
###iOS
25
27
Open Settings -> Privacy -> Location Services -> Camera (app).
26
28
27
29
28
30
## Use it with Photo widget
29
-
The parameter `<ABSOLUTE_PATH_TO_IMAGE>` can be set with an expression using value of another field.
30
-
Therefore you can use a value from a text field of an attachment type as a parameter for Input's EXIF functions as following:
31
+
The parameter `<ABSOLUTE_PATH_TO_IMAGE>` can be set with an expression using value of another field. Therefore you can use a value from a text field of an attachment type as a parameter for Input's EXIF functions as following:
You can use both `Take a photo` or `From gallery` actions of the attachment widget. While capturing a photo with a camera,
35
-
GPS EXIF data are added to the photo metadata. Make sure that location permissions are allowed in Input and also
36
-
for your camera app.
35
+
You can use both `Take a photo` or `From gallery` actions of the attachment widget. While capturing a photo with a camera, GPS EXIF data are added to the photo metadata. Make sure that location permissions are allowed in Input and also for your camera app.
37
36
38
37
For further examples you can check fields definitions of project <MerginMapsProjectid="lutraconsulting/test_exif" /> accessible on Mergin.
Copy file name to clipboardExpand all lines: src/howto/input_features.md
+8-25Lines changed: 8 additions & 25 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,39 +15,29 @@ To be able to transfer your data to your mobile/tablet device, share your projec
15
15
- You can sign in to your Mergin account
16
16
17
17
## Accessing projects
18
-
You can install Input from Google Play Store. Once you open the
19
-
application for the first time, it will take you to **Home** screen.
20
-
This screen displays all the projects stored locally (under
21
-
/sdcard/INPUT folder).
18
+
You can install Input from Google Play Store. Once you open the application for the first time, it will take you to **Home** screen. This screen displays all the projects stored locally (under /sdcard/INPUT folder).
22
19
23
20
24
21
25
-
To access your projects or those shared with you through Mergin, select
26
-
**My projects** or **Shared with me** tabs respectively. You will need your log in details to sign in to
27
-
Mergin:
22
+
To access your projects or those shared with you through Mergin, select **My projects** or **Shared with me** tabs respectively. You will need your log in details to sign in to Mergin:
28
23
29
24
30
25
31
-
Once logged in, you can download your project to work on it locally by
32
-
pressing download button to the right of the project:
26
+
Once logged in, you can download your project to work on it locally by pressing download button to the right of the project:
33
27
34
28
35
29
36
-
The project will be available for loading in Input after you download it locally.
37
-
Select **Home** and you should be able to see your downloaded
38
-
project:
30
+
The project will be available for loading in Input after you download it locally. Select **Home** and you should be able to see your downloaded project:
39
31
40
32
41
33
42
34
Selecting a project under **Home** will open it in INPUT.
43
35
44
36
## Adding/editing features
45
37
46
-
To add a feature, select the record button from the lower panel. When you tap on the record button, it will list all the
47
-
layers, you can edit. In Input, you have two modes to capture feature:
38
+
To add a feature, select the record button from the lower panel. When you tap on the record button, it will list all the layers, you can edit. In Input, you have two modes to capture feature:
48
39
49
40
- GPS location or streaming (if you are capturing lines/areas)
50
-
51
41
- Free hand: by adding points or nodes to lines or areas
52
42
53
43
### Capturing points
@@ -65,27 +55,20 @@ If your survey layer is a line or area, the panel at the bottom changes to a fig
65
55
You can:
66
56
67
57
- Use **Add point** to define the shape of your line or area manually by navigating through the map
68
-
69
58
- If you want to **stream** the GPS to shape your line or area, press and hold **GPS** button on the bottom left corner.
70
59
71
60
Once finished, press **Done**. If your feature is an area, it will join the last point to the first point to close the shape.
72
61
73
62
## Viewing/deleting existing data
74
-
You can view the existing data by tapping on them on the map. It will
75
-
open a preview panel (according to Display settings in QGIS - see
76
-
project preparation section). To edit the form related to an existing
77
-
feature, you can press the pencil within the preview panel.
63
+
You can view the existing data by tapping on them on the map. It will open a preview panel (according to Display settings in QGIS - see project preparation section). To edit the form related to an existing feature, you can press the pencil within the preview panel.
78
64
79
65
For point layers, you can also change the location (geometry) of your layer, by pressing **Edit geometry**. Similar to capturing a new point, a map will appear with a cross-hair at your GPS location. You can adjust the location of the cross-hair by panning the map and press **Confirm**.
80
66
81
-
If you want to delete the item, you can press the recycle bin from the lower panel
82
-
in the form edit.
67
+
If you want to delete the item, you can press the recycle bin from the lower panel in the form edit.
83
68
84
69
## Synchronisation of data/ projects
85
70
You can upload your changes through the Mergin service, once you have network connectivity. Select Project from the lower panel and then tap on **My projects** (or **Shared with me** if you have write access to the shared project). Input should automatically flag changed projects with a synchronise icon.
86
71
87
72
88
73
89
-
Pressing sync button to the right of the project will send the updated
90
-
data to the Mergin service. Similarly, if a project and its data has been updated
91
-
through the Mergin service, you will be notified to synchronise the changes to your local copy.
74
+
Pressing sync button to the right of the project will send the updated data to the Mergin service. Similarly, if a project and its data has been updated through the Mergin service, you will be notified to synchronise the changes to your local copy.
Copy file name to clipboardExpand all lines: src/howto/input_ui.md
+10-26Lines changed: 10 additions & 26 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,35 +17,24 @@ You can **Search** for projects using the search bar on the top. To access your
17
17
18
18
19
19
## GPS
20
-
By default, the map centred around the project extent. Pressing
21
-
and holding GPS icon, will turn on the GPS auto-centre mode.
20
+
By default, the map centred around the project extent. Pressing and holding GPS icon, will turn on the GPS auto-centre mode.
22
21
23
-
GPS signal colour on the map denotes the accuracy threshold set by user
24
-
within the Input settings (See Settings section).
22
+
GPS signal colour on the map denotes the accuracy threshold set by user within the Input settings (See Settings section).
25
23
26
24
## Record
27
-
This option will allow user to capture the position of the GPS and save it
28
-
as point or line vertices. Pressing the **Record** button will
29
-
list all the survey layers (point and line layers within the project not
30
-
marked as read-only in the QGIS project properties). User can then
31
-
select a layer.
25
+
This option will allow user to capture the position of the GPS and save it as point or line vertices. Pressing the **Record** button will list all the survey layers (point and line layers within the project not marked as read-only in the QGIS project properties). User can then select a layer.
32
26
33
-
If a point layer is selected, a point geometry will be recorded at the
34
-
location of the GPS. A form (attribute table) for the point will appear
35
-
for user to fill in.
27
+
If a point layer is selected, a point geometry will be recorded at the location of the GPS. A form (attribute table) for the point will appear for user to fill in.
36
28
37
-
If a line layer is selected, a path will be generated from the GPS track
38
-
until the record button is pressed again. The form for the recorded line
39
-
will appear accordingly.
29
+
If a line layer is selected, a path will be generated from the GPS track until the record button is pressed again. The form for the recorded line will appear accordingly.
40
30
41
31
Pressing and holding **Record** button will allow you to set the default survey layer. This option is also available under the **Settings** section.
42
32
43
33
## Zoom to project
44
34
This is a shortcut to zoom the extent of all visible layers within the project.
45
35
46
36
## Map themes
47
-
Themes generated from QGIS project will be listed here. User can switch
48
-
between different map themes using this option.
37
+
Themes generated from QGIS project will be listed here. User can switch between different map themes using this option.
49
38
50
39
## Settings
51
40
Input specific configuration can be accessed through settings.
@@ -54,17 +43,12 @@ Input specific configuration can be accessed through settings.
54
43
55
44
### Mergin
56
45
57
-
Displays the current user signed in to Mergin. To clear the log in,
58
-
users can tap on their name.
46
+
Displays the current user signed in to Mergin. To clear the log in, users can tap on their name.
59
47
60
48
### GPS
61
49
62
-
**Follow GPS with map** will pan the map so the GPS point can be seen on the
63
-
map.
50
+
**Follow GPS with map** will pan the map so the GPS point can be seen on the map.
64
51
65
-
**GPS accuracy** colours show the current strength of the signal based on the
66
-
Accuracy threshold. If the signal falls within the the threshold, the
67
-
colour will be green. If it is outside, it will be orange. The indicator
68
-
will be red in case there is no GPS position fix available.
52
+
**GPS accuracy** colours show the current strength of the signal based on the Accuracy threshold. If the signal falls within the the threshold, the colour will be green. If it is outside, it will be orange. The indicator will be red in case there is no GPS position fix available.
69
53
70
-
**Line rec. interval** when streaming GPS position for capturing lines, you can set the intervals at which the GPS location will be used as vertices of the line.
54
+
**Line rec. interval** when streaming GPS position for capturing lines, you can set the intervals at which the GPS location will be used as vertices of the line.
Copy file name to clipboardExpand all lines: src/howto/integration.md
+9-21Lines changed: 9 additions & 21 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,15 +1,12 @@
1
1
# Integrate Mergin
2
2
3
-
Mergin is an open platform that aims to be developer friendly,
4
-
and it has been designed to allow easy integration with other software.
3
+
Mergin is an open platform that aims to be developer friendly, and it has been designed to allow easy integration with other software.
5
4
6
5
## Python Client
7
6
8
7
### Installation
9
8
10
-
The easiest way to use Mergin programmatically is to use the Python
11
-
client module. It is available in the PyPI repository and so it can
12
-
be installed with `pip`:
9
+
The easiest way to use Mergin programmatically is to use the Python client module. It is available in the PyPI repository and so it can be installed with `pip`:
13
10
14
11
```
15
12
pip3 install mergin-client
@@ -26,35 +23,28 @@ mc = MerginClient(login='john', password='pass')
You can of course also get project status, push/pull changes, create/delete projects
30
-
and more.
26
+
You can of course also get project status, push/pull changes, create/delete projects and more.
31
27
32
28
The source code of the Python client is available on GitHub in <GitHubRepoid="lutraconsulting/mergin-py-client" /> repository.
33
29
34
30
### Command Line Interface
35
31
36
-
For those who prefer using terminal, there is `mergin` command line tool
37
-
shipped with the Python client.
38
-
With several built-in commands, it is possible to download Mergin projects,
39
-
push/pull changes, create or delete projects and more.
32
+
For those who prefer using terminal, there is `mergin` command line tool shipped with the Python client. With several built-in commands, it is possible to download Mergin projects, push/pull changes, create or delete projects and more.
40
33
41
34
For example, to download a Mergin project to a local directory:
42
35
```
43
36
mergin download john/project1 ~/mergin/project1
44
37
```
45
38
46
-
Please see <GitHubRepoid="lutraconsulting/mergin-py-client" /> repository for
47
-
more information on the usage.
39
+
Please see <GitHubRepoid="lutraconsulting/mergin-py-client" /> repository for more information on the usage.
48
40
49
41
## C++ Standalone Client
50
42
51
-
C++ Client has advantage over Python that is is completely
52
-
without any dependencies.
43
+
C++ Client has advantage over Python that is is completely without any dependencies.
53
44
54
45
### Installation
55
46
56
-
Just <GitHubRepoid="lutraconsulting/mergin-cpp-client/releases"desc="download"/> binary for your platform and
57
-
use it from command line.
47
+
Just <GitHubRepoid="lutraconsulting/mergin-cpp-client/releases"desc="download"/> binary for your platform and use it from command line.
58
48
59
49
### Usage
60
50
```bash
@@ -75,10 +65,8 @@ Commands:
75
65
remove Remove project from server.
76
66
```
77
67
78
-
Please see <GitHubRepoid="lutraconsulting/mergin-cpp-client" /> repository
79
-
for more information on the usage.
68
+
Please see <GitHubRepoid="lutraconsulting/mergin-cpp-client" /> repository for more information on the usage.
80
69
81
70
### C++ Mergin API Core Library
82
71
83
-
Client is based on the Qt-based <GitHubRepoid="lutraconsulting/input/tree/master/core"desc="mergin api core library" />
84
-
used by the [Input App](https://inputapp.io) to sync the projects in the mobile application
72
+
Client is based on the Qt-based <GitHubRepoid="lutraconsulting/input/tree/master/core"desc="mergin api core library" /> used by the [Input App](https://inputapp.io) to sync the projects in the mobile application.
Copy file name to clipboardExpand all lines: src/howto/mergince.md
+3-8Lines changed: 3 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,15 +2,10 @@
2
2
3
3
<PublicImagesrc="Mergin.svg" />
4
4
5
-
The [Mergin](https://public.cloudmergin.com) is a great companion to Input as it
6
-
provides seamless synchronisation of data between your phone/tablet,
7
-
Mergin service and QGIS Desktop.
5
+
The [Mergin](https://public.cloudmergin.com) is a great companion to Input as it provides seamless synchronisation of data between your phone/tablet, Mergin service and QGIS Desktop.
8
6
9
-
The good news is that Mergin CE is licensed as open source software and therefore
10
-
it is possible to do your custom deployments.
7
+
The good news is that Mergin CE is licensed as open source software and therefore it is possible to do your custom deployments.
11
8
12
9
## GitHub
13
10
14
-
If you are interested in deploying Mergin CE, you can start by going to
15
-
<GitHubRepoid="lutraconsulting/mergin" /> on GitHub and
16
-
read instructions how to deploy it for your platform.
11
+
If you are interested in deploying Mergin CE, you can start by going to <GitHubRepoid="lutraconsulting/mergin" /> on GitHub and read instructions how to deploy it for your platform.
0 commit comments