Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Develop/3.7 #1521

Merged
merged 38 commits into from
Jun 17, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
38 commits
Select commit Hold shift + click to select a range
3a1f867
edited text
stitenko May 3, 2024
27a736f
update haproxy guides
trikimiki May 10, 2024
9376df0
remove virtualbox commands from docker on windows
trikimiki May 10, 2024
afff287
update install guides jdk17-ready
trikimiki May 10, 2024
bbeea0a
update instruction description to java 17
trikimiki May 10, 2024
c551176
fix typo
trikimiki May 10, 2024
cfb8938
jdk17 instruction clarification
trikimiki May 13, 2024
116b7ed
change docker kafka image to bitnami
trikimiki May 14, 2024
1c29107
edited by Dasha
stitenko May 16, 2024
55e8743
remove unnecessary kafka params
trikimiki May 16, 2024
fb9da63
more specific rhel cassandra link
trikimiki May 16, 2024
d9ce573
edited by Dasha
stitenko May 21, 2024
7586649
minor changes
stitenko May 23, 2024
14a5d12
created guide
stitenko May 24, 2024
8a29673
added CE
stitenko May 29, 2024
24267a4
added new action On cell click
stitenko May 29, 2024
7998258
editing doc
stitenko May 30, 2024
9dd68e8
edited by Hleb
stitenko May 30, 2024
54318bf
editing doc
stitenko May 30, 2024
8c17182
edited by Hleb
stitenko May 30, 2024
f771fcb
minor edited text
stitenko May 31, 2024
f871447
Merge pull request #1473 from stitenko/04.2024/custom-translation-upd…
ashvayka Jun 3, 2024
ad1e17e
edited text
stitenko Jun 4, 2024
9b6dbe3
edited text
stitenko Jun 4, 2024
7445dea
edited text
stitenko Jun 5, 2024
1ff68ad
edited text
stitenko Jun 6, 2024
e6b22eb
edited text
stitenko Jun 6, 2024
4bec3a2
create guide
stitenko Jun 6, 2024
b20cacc
final edited text
stitenko Jun 7, 2024
8ab568a
final edited text
stitenko Jun 7, 2024
686b80a
edited text
stitenko Jun 10, 2024
2e0fa8c
final edited text
stitenko Jun 10, 2024
fbdb237
Merge pull request #1511 from stitenko/05.2024/qr-code-guide
ashvayka Jun 12, 2024
1a6c87c
Merge pull request #1493 from stitenko/05.2024/alias-on-cell-click
ashvayka Jun 12, 2024
45f7203
Merge pull request #1479 from trikimiki/develop/3.7
ashvayka Jun 13, 2024
69c36c4
added screenshot
stitenko Jun 13, 2024
f0e0f78
minor edited text
stitenko Jun 13, 2024
0fbd423
Merge pull request #1519 from stitenko/06.2024/qr-code-custom-setting…
ashvayka Jun 17, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
13 changes: 8 additions & 5 deletions _data/docs-home.yml
Original file line number Diff line number Diff line change
Expand Up @@ -127,18 +127,19 @@ toc:
- title: Templatization
path: /docs/user-guide/templatization/
new: true
- title: White Labeling
- title: White labeling
pe: true
section:
- title: Overview
path: /docs/pe/user-guide/white-labeling/
- title: Self-registration
path: /docs/pe/user-guide/self-registration/
- title: Mail Templates
- title: Mail templates
path: /docs/pe/user-guide/mail-templates/
- title: Custom Translations
- title: Custom translation
path: /docs/pe/user-guide/custom-translation/
- title: Custom Menu
new: true
- title: Custom menu
path: /docs/pe/user-guide/custom-menu/
- title: Integrations
pe: true
Expand Down Expand Up @@ -316,9 +317,11 @@ toc:
path: /docs/user-guide/ui/slack-settings/
- title: Microsoft Teams Settings
path: /docs/user-guide/ui/microsoft-teams-settings/
new: true
- title: Mail Settings
path: /docs/user-guide/ui/mail-settings/
- title: Mobile application QR code
path: /docs/user-guide/ui/mobile-qr-code/
new: true
- title: JWT Security Settings
path: /docs/user-guide/ui/jwt-security-settings/
- title: Contribution Guide
Expand Down
2 changes: 2 additions & 0 deletions _data/mobile-pe/docs-home.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,5 +23,7 @@ toc:
path: /docs/pe/mobile/white-labeling/
- title: Self-registration
path: /docs/pe/mobile/self-registration/
- title: QR code settings
path: /docs/pe/mobile/qr-code-settings/
- title: Publish your app
path: /docs/pe/mobile/release/
2 changes: 2 additions & 0 deletions _data/mobile/docs-home.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,5 +19,7 @@ toc:
path: /docs/mobile/mobile-actions/
- title: OAuth 2.0
path: /docs/mobile/oauth2/
- title: QR code settings
path: /docs/mobile/qr-code-settings/
- title: Publish your app
path: /docs/mobile/release/
13 changes: 8 additions & 5 deletions _data/paas/docs-home.yml
Original file line number Diff line number Diff line change
Expand Up @@ -144,17 +144,18 @@ toc:
- title: Templatization
path: /docs/paas/user-guide/templatization/
new: true
- title: White Labeling
- title: White labeling
section:
- title: Overview
path: /docs/paas/user-guide/white-labeling/
- title: Self-registration
path: /docs/paas/user-guide/self-registration/
- title: Mail Templates
- title: Mail templates
path: /docs/paas/user-guide/mail-templates/
- title: Custom Translations
- title: Custom translation
path: /docs/paas/user-guide/custom-translation/
- title: Custom Menu
new: true
- title: Custom menu
path: /docs/paas/user-guide/custom-menu/
- title: Integrations
section:
Expand Down Expand Up @@ -304,9 +305,11 @@ toc:
path: /docs/paas/user-guide/ui/slack-settings/
- title: Microsoft Teams Settings
path: /docs/paas/user-guide/ui/microsoft-teams-settings/
new: true
- title: Mail Settings
path: /docs/paas/user-guide/ui/mail-settings/
- title: Mobile application QR code
path: /docs/paas/user-guide/ui/mobile-qr-code/
new: true
- title: Subscriptions
path: /products/paas/subscription/
- title: Plan and billing
Expand Down
13 changes: 8 additions & 5 deletions _data/pe/docs-home.yml
Original file line number Diff line number Diff line change
Expand Up @@ -144,17 +144,18 @@ toc:
- title: Templatization
path: /docs/pe/user-guide/templatization/
new: true
- title: White Labeling
- title: White labeling
section:
- title: Overview
path: /docs/pe/user-guide/white-labeling/
- title: Self-registration
path: /docs/pe/user-guide/self-registration/
- title: Mail Templates
- title: Mail templates
path: /docs/pe/user-guide/mail-templates/
- title: Custom Translations
- title: Custom translation
path: /docs/pe/user-guide/custom-translation/
- title: Custom Menu
new: true
- title: Custom menu
path: /docs/pe/user-guide/custom-menu/
- title: Integrations
section:
Expand Down Expand Up @@ -322,9 +323,11 @@ toc:
path: /docs/pe/user-guide/ui/slack-settings/
- title: Microsoft Teams Settings
path: /docs/pe/user-guide/ui/microsoft-teams-settings/
new: true
- title: Mail Settings
path: /docs/pe/user-guide/ui/mail-settings/
- title: Mobile application QR code
path: /docs/pe/user-guide/ui/mobile-qr-code/
new: true
- title: JWT Security Settings
path: /docs/pe/user-guide/ui/jwt-security-settings/
- title: Contribution Guide
Expand Down
2 changes: 2 additions & 0 deletions _includes/docs/mobile/customization.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,9 @@
- **[Setup alarm details dashboard](/docs/{{docsPrefix}}mobile/alarm-dashboard)**
- **[Configure mobile actions](/docs/{{docsPrefix}}mobile/mobile-actions)**
- **[Configure OAuth 2.0](/docs/{{docsPrefix}}mobile/oauth2)**
- **[Configure mobile app QR code settings](/docs/{{docsPrefix}}mobile/qr-code-settings/)**
{% if docsPrefix == 'pe/' %}
- **[Configure white-labeling](/docs/pe/mobile/white-labeling)**
- **[Configure self-registration](/docs/pe/mobile/self-registration)**
- **[Configure mobile app QR code settings](/docs/pe/mobile/qr-code-settings/)**
{% endif %}
94 changes: 94 additions & 0 deletions _includes/docs/mobile/qr-code-settings.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,94 @@
* TOC
{:toc}

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.
Whether you're looking to customize an existing app with your own source code from {% if docsPrefix == "pe/" %}[GitHub](https://github.com/thingsboard/flutter_thingsboard_pe_app){:target="_blank"}{% endif %}{% if docsPrefix == null %}[GitHub](https://github.com/thingsboard/flutter_thingsboard_app){:target="_blank"}{% endif %} or direct it to a custom host, this document will walk you through the necessary steps.

## Android app settings

### Direct Android application to your own host

To direct your custom application to your own host, you need to modify `AndroidManifest.xml` file:

- Open the Flutter project with VS Code or Android Studio;
- Navigate to `android/app/src/main/AndroidManifest.xml` file;
- Modify **AndroidManifest.xml**. You have to update `android:host=` with your host:

```text
<!-- App Links -->
<intent-filter android:autoVerify="true">
<action android:name="android.intent.action.VIEW" />
<category android:name="android.intent.category.DEFAULT" />
<category android:name="android.intent.category.BROWSABLE" />
<data
android:scheme="https"
android:host="thingsboard.cloud"
android:pathPrefix="/api/noauth/qr" />
</intent-filter>
```

### Mobile app QR code widget settings for Android

To launch your custom mobile application when scanning a QR code, you need to specify the "[App package name](#app-package-name)" and "[SHA256 certificate fingerprints](#sha256-certificate-fingerprints)" in the [ThingsBoard Mobile app QR code widget settings](/docs/{{peDocsPrefix}}user-guide/ui/mobile-qr-code/#configuring-qr-code-widget-on-home-page){:target="_blank"}.

#### App package name

Find the app package name **applicationId** in **build.gradle** file located at `android/app/build.gradle`:

```text
defaultConfig {
// TODO: Specify your own unique Application ID (https://developer.android.com/studio/build/application-id.html).
applicationId "org.thingsboard.pe.app"
}
```

#### SHA256 certificate fingerprints

If your app distributed via Google Play you need to use SHA-256 certificate fingerprint located in your developer account under **Release> Setup > App Integrity> App Signing tab:**

![image](/images/mobile/sha256-fingerprint.png)

If you app distributed locally you need to use the sha256 key your apk signed with

Read more in the guide "[Set up app links for Android](https://docs.flutter.dev/cookbook/navigation/set-up-app-links#sha256-fingerprint){:target="_blank"}", available in the official Firebase documentation.

## iOS app settings

### Direct iOS application to your own host

To direct your iOS application to your own host, you need to modify `entitlements.xml` file:

- Open and modify `ios/YOUR_APP_NAME/YOUR_APP_NAME.entitlements.xml` file in your preferred IDE;
- Modify **entitlements.xml** with your domain: You have to update `applinks` with your host:

```text
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
<key>aps-environment</key>
<string>development</string>
<key>com.apple.developer.associated-domains</key>
<array>
<string>applinks:thingsboard.cloud</string>
</array>
</dict>
</plist>
```

### Mobile app QR code widget settings for iOS

To launch your custom iOS mobile application when scanning a QR code, you need to specify the "[App ID](#app-id)" in the [ThingsBoard Mobile app QR code widget settings](/docs/{{peDocsPrefix}}user-guide/ui/mobile-qr-code/#configuring-qr-code-widget-on-home-page){:target="_blank"}.

#### App ID

When you create your Xcode project from a template, the bundle ID ([CFBundleIdentifier](https://developer.apple.com/documentation/bundleresources/information_property_list/cfbundleidentifier){:target="_blank"}) uniquely identifies your app throughout the system.
This ID combines the organization ID and the app name that you enter in reverse-DNS format.
For example, if you enter "Runner" as the app name for your organization, the bundle identifier will be `com.mycompany.app.Runner`.

To find the bundle ID (**App ID**), you need to:
- Choose the target;
- Click the "Signing & Capabilities" pane;
- Find the bundle identifier (App ID) in the "Signing" section.

![image](/images/mobile/qr-code-app-id.png)
Loading