Skip to content

Commit 32926de

Browse files
committed
Merge branch 'staging/4.2' into release/4.2
2 parents fdaf9d3 + 9debd60 commit 32926de

9 files changed

Lines changed: 101 additions & 70 deletions

File tree

_data/mobile-pe/docs-home.yml

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -25,13 +25,9 @@ toc:
2525
path: /docs/pe/mobile/app-icon-splash-screen/
2626
- title: Self-registration
2727
path: /docs/pe/mobile/self-registration/
28-
- title: QR code settings (Mobile app v1.7.x)
28+
- title: QR code settings
2929
path: /docs/pe/mobile/qr-code-settings/
30-
- title: QR code settings (Mobile app v1.6.x)
31-
path: /docs/pe/mobile/qr-code-settings-before-v1.7/
3230
- title: Add your own localization
3331
path: /docs/pe/mobile/localization/
34-
- title: Publish your app (Mobile app v1.6.x)
35-
path: /docs/pe/mobile/release-before-v1.7/
36-
- title: Publish your app (Mobile app v1.7.x)
32+
- title: Publish your app
3733
path: /docs/pe/mobile/release/

_data/mobile/docs-home.yml

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -19,15 +19,11 @@ toc:
1919
path: /docs/mobile/mobile-actions/
2020
- title: OAuth 2.0
2121
path: /docs/mobile/oauth2/
22-
- title: QR code settings (Mobile app v1.7.x)
22+
- title: QR code settings
2323
path: /docs/mobile/qr-code-settings/
24-
- title: QR code settings (Mobile app v1.6.x)
25-
path: /docs/mobile/qr-code-settings-before-v1.7/
2624
- title: App icon and splash screen
2725
path: /docs/mobile/app-icon-splash-screen/
2826
- title: Add your own localization
2927
path: /docs/mobile/localization/
30-
- title: Publish your app (Mobile app v1.6.x)
31-
path: /docs/mobile/release-before-v1.7/
32-
- title: Publish your app (Mobile app v1.7.x)
28+
- title: Publish your app
3329
path: /docs/mobile/release/

_data/pages_info.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -679,6 +679,9 @@
679679
"/docs/mobile/alarm-dashboard/":
680680
url: "/docs/mobile/alarm-dashboard/"
681681
redirect_from: []
682+
"/docs/mobile/app-icon-splash-screen-before-v1.7/":
683+
url: "/docs/mobile/app-icon-splash-screen-before-v1.7/"
684+
redirect_from: []
682685
"/docs/mobile/app-icon-splash-screen/":
683686
url: "/docs/mobile/app-icon-splash-screen/"
684687
redirect_from: []
@@ -3215,6 +3218,9 @@
32153218
"/docs/pe/mobile/alarm-dashboard/":
32163219
url: "/docs/pe/mobile/alarm-dashboard/"
32173220
redirect_from: []
3221+
"/docs/pe/mobile/app-icon-splash-screen-before-v1.7/":
3222+
url: "/docs/pe/mobile/app-icon-splash-screen-before-v1.7/"
3223+
redirect_from: []
32183224
"/docs/pe/mobile/app-icon-splash-screen/":
32193225
url: "/docs/pe/mobile/app-icon-splash-screen/"
32203226
redirect_from: []
Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
{% if docsPrefix == 'pe/' %}
2+
{% assign peDocsPrefix = "pe/" %}
3+
{% else %}
4+
{% assign peDocsPrefix = "" %}
5+
{% endif %}
6+
* TOC
7+
{:toc}
8+
9+
### Splash Screen
10+
11+
You cannot change the splash screen in pre-1.7.0 versions. It will default to your app's icon.
12+
13+
### App Icon
14+
15+
The Flutter app comes with a default launcher icon. To change it with your custom one, follow these instructions:
16+
17+
#### Step 1: Add flutter_launcher_icons Plugin
18+
19+
Add the flutter_launcher_icons plugin to your project via command line:
20+
21+
```bash
22+
flutter pub add dev:flutter_launcher_icons
23+
```
24+
{: .copy-code}
25+
#### Step 2: Replace Default Icon
26+
27+
Replace `thingsboard.png` in the `assets/images` folder with your custom icon. We recommend using a 432×432 pixel image of your logo centered within the canvas.
28+
29+
#### Step 3: Run the Generator
30+
31+
Execute the generator to apply your new icon:
32+
33+
```bash
34+
flutter pub run flutter_launcher_icons
35+
```
36+
{: .copy-code}
37+
38+
#### Step 4: Update Notification Icon (Optional)
39+
40+
If you have configured push notifications (see [push notifications setup guide](/docs/pe/mobile/getting-started/#step-2-optional-configure-push-notifications)), we recommend updating the notification icon as well.
41+
42+
1. Go to [Android Asset Studio](https://romannurik.github.io/AndroidAssetStudio/icons-notification.html)
43+
2. Press "Image" and choose your logo
44+
3. Configure padding if needed
45+
4. Change the file name to "thingsboard"
46+
5. Press the download button to get an archive of the "res" folder
47+
6. Paste the contents to `android/app/src/main` and click "Replace" when prompted
48+
49+
<div style="display: flex; flex-direction: row;">
50+
<div style="display: flex; flex-direction: column; align-items: center;">
51+
<img width="" src="https://img.thingsboard.io/mobile/asset_studio.png" title="Android asset studio flow" alt="Android asset studio flow">
52+
</div>
53+
</div>
54+
55+
{% capture pre_version_note %}
56+
**Note:** Pre-1.7.0 versions have limited customization options compared to newer versions. Consider upgrading to version 1.7.0+ for full branding capabilities.
57+
{% endcapture %}
58+
{% include templates/info-banner.md content=pre_version_note %}

_includes/docs/mobile/app-icon-splash-screen.md

Lines changed: 10 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
{% if docsPrefix == 'pe/' %}
2+
{% assign peDocsPrefix = "pe/" %}
3+
{% else %}
4+
{% assign peDocsPrefix = "" %}
5+
{% endif %}
16
* TOC
27
{:toc}
38

@@ -7,10 +12,13 @@ An **app icon** is the visual representation of your application that appears on
712

813
A **splash screen** is the initial screen displayed when an application is launched, typically showing a logo or branding while the app loads.
914

10-
## App version 1.7.0+
11-
1215
For app version 1.7.0 and above, you need several assets to fully customize your app. You will find default examples of the required assets in the `assets/branding` folder.
1316

17+
{% capture pre_1_7_0_link %}
18+
Important Notice: Please use [this guide](/docs/{{peDocsPrefix}}mobile/app-icon-splash-screen-before-v1.7/) for pre 1.7.x configuration
19+
{% endcapture %} {% include templates/info-banner.md content=pre_1_7_0_link %}
20+
21+
1422
### Required Assets
1523

1624
The following assets are required for complete customization:
@@ -143,58 +151,3 @@ dart run flutter_launcher_icons
143151
dart run flutter_native_splash:create
144152
```
145153
{: .copy-code}
146-
147-
## App version pre 1.7.0
148-
149-
For app versions prior to 1.7.0, the customization process is different and more limited.
150-
151-
### Splash Screen
152-
153-
You cannot change the splash screen in pre-1.7.0 versions. It will default to your app's icon.
154-
155-
### App Icon
156-
157-
The Flutter app comes with a default launcher icon. To change it with your custom one, follow these instructions:
158-
159-
#### Step 1: Add flutter_launcher_icons Plugin
160-
161-
Add the flutter_launcher_icons plugin to your project via command line:
162-
163-
```bash
164-
flutter pub add dev:flutter_launcher_icons
165-
```
166-
{: .copy-code}
167-
#### Step 2: Replace Default Icon
168-
169-
Replace `thingsboard.png` in the `assets/images` folder with your custom icon. We recommend using a 432×432 pixel image of your logo centered within the canvas.
170-
171-
#### Step 3: Run the Generator
172-
173-
Execute the generator to apply your new icon:
174-
175-
```bash
176-
flutter pub run flutter_launcher_icons
177-
```
178-
{: .copy-code}
179-
180-
#### Step 4: Update Notification Icon (Optional)
181-
182-
If you have configured push notifications (see [push notifications setup guide](/docs/pe/mobile/getting-started/#step-2-optional-configure-push-notifications)), we recommend updating the notification icon as well.
183-
184-
1. Go to [Android Asset Studio](https://romannurik.github.io/AndroidAssetStudio/icons-notification.html)
185-
2. Press "Image" and choose your logo
186-
3. Configure padding if needed
187-
4. Change the file name to "thingsboard"
188-
5. Press the download button to get an archive of the "res" folder
189-
6. Paste the contents to `android/app/src/main` and click "Replace" when prompted
190-
191-
<div style="display: flex; flex-direction: row;">
192-
<div style="display: flex; flex-direction: column; align-items: center;">
193-
<img width="" src="https://img.thingsboard.io/mobile/asset_studio.png" title="Android asset studio flow" alt="Android asset studio flow">
194-
</div>
195-
</div>
196-
197-
{% capture pre_version_note %}
198-
**Note:** Pre-1.7.0 versions have limited customization options compared to newer versions. Consider upgrading to version 1.7.0+ for full branding capabilities.
199-
{% endcapture %}
200-
{% include templates/info-banner.md content=pre_version_note %}

_includes/docs/mobile/qr-code-settings.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,11 @@
88

99
This guide provides instructions on how to configure a custom mobile application to launch directly from a [QR code scan](/docs/{{peDocsPrefix}}user-guide/ui/mobile-qr-code/) using your phone's camera.
1010

11-
In application version 1.7.0+, we have made QR code settings configuration much easier through the platform interface.
11+
In application version 1.7.0+, we have made QR code settings configuration much easier by using configuration file.
12+
13+
{% capture pre_1_7_0_link %}
14+
Important Notice: Please use [this guide](/docs/{{peDocsPrefix}}mobile/qr-code-settings-before-v1.7/) for pre 1.7.x qr code configuration
15+
{% endcapture %} {% include templates/info-banner.md content=pre_1_7_0_link %}
1216

1317
## Platform Configuration
1418

_includes/docs/mobile/release.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,10 @@
66
* TOC
77
{:toc}
88

9+
{% capture pre_1_7_0_link %}
10+
Important Notice: Please use [this guide](/docs/{{peDocsPrefix}}mobile/release-before-v1.7/) for pre 1.7.x app publish instructions
11+
{% endcapture %} {% include templates/info-banner.md content=pre_1_7_0_link %}
12+
913
## Configure the App
1014

1115
Your app package name and app name will come preconfigured from your Mobile Center in the configuration file that you downloaded after app bundle creation in the Mobile Center.
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
layout: docwithnav-mobile
3+
title: Configure app icon and splash screen in ThingsBoard Mobile Application
4+
5+
---
6+
7+
{% include docs/mobile/app-icon-splash-screen-before-v1.7.md %}
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
layout: docwithnav-mobile-pe
3+
title: Configure app icon and splash screen in ThingsBoard Mobile Application
4+
5+
---
6+
{% assign docsPrefix = "pe/" %}
7+
{% include docs/mobile/app-icon-splash-screen-before-v1.7.md %}

0 commit comments

Comments
 (0)