Skip to content

Commit 981c8ae

Browse files
authored
Clarify micrordk connection stability troubleshooting (#3853)
1 parent 1836b6a commit 981c8ae

File tree

2 files changed

+11
-13
lines changed

2 files changed

+11
-13
lines changed

Diff for: docs/data-ai/capture-data/capture-sync.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -709,7 +709,7 @@ The following components and services support data capture and cloud sync:
709709
## Considerations
710710

711711
- **Capturing too much data**: You can [use filtering to collect and sync only certain images](/data-ai/capture-data/filter-before-sync/) to capture data selectively.
712-
- **Rentention policy**: Set a `retention_policy` attribute in your [data capture configuration](#configure-data-capture) to avoid keeping data stored in the Viam Cloud longer than a specified number of days.
712+
- **Retention policy**: Set a `retention_policy` attribute in your [data capture configuration](#configure-data-capture) to avoid keeping data stored in the Viam Cloud longer than a specified number of days.
713713
- **Pausing sync**: You can pause cloud sync at any time by navigating to your machine's **CONFIGURE** tab and disabling **Syncing** for your data management service.
714714

715715
If you have captured data that you do not want to sync, delete the data on the machine before resuming cloud sync.

Diff for: docs/operate/reference/viam-micro-server/viam-micro-server-setup.md

+10-12
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,11 @@ For more `micro-rdk-installer` CLI usage options, see [GitHub](https://github.co
1515

1616
For code examples and more information on `viam-micro-server`, see [GitHub](https://github.com/viamrobotics/micro-rdk).
1717

18-
## SDK usage recommendation
18+
## Unstable connection
1919

20-
If you run [control code](/dev/reference/sdks/) to control your `viam-micro-server` machine, you may experience instability.
21-
If the connection to the ESP32 with an SDK is unstable, we recommend the following changes to the default settings in your connection code.
22-
This will disable the SDK background task that monitors the connection to `viam-micro-server`, saving bandwidth.
20+
Because microcontrollers are more resource-constrained than single-board computers or other computers, when you run [control code](/dev/reference/sdks/) to control your `viam-micro-server` machine, you may experience instability.
21+
If your connection is unstable, we recommend changing the default settings by making the following changes to your connection code.
22+
This code will disable the SDK background task that monitors the connection to `viam-micro-server`, reducing processing demands and improving the reliability of connection establishment.
2323

2424
{{< tabs >}}
2525
{{% tab name="Python" %}}
@@ -35,9 +35,9 @@ async def connect():
3535
check_connection_interval=0,
3636
# Same for Attempting to reconnect
3737
attempt_reconnect_interval=0,
38-
disable_sessions=True,
3938
# viam-micro-server doesn't support sessions
4039
# so it is safe to disable them
40+
disable_sessions=True,
4141
dial_options=DialOptions.with_api_key(
4242
# Replace "<API-KEY-ID>" (including brackets)
4343
# with your machine's api key id
@@ -81,25 +81,23 @@ if err != nil {
8181
{{% /tab %}}
8282
{{% /tabs %}}
8383

84-
## Troubleshooting
85-
86-
### Error: IceTransportClosed
84+
## Error: IceTransportClosed
8785

8886
If you are trying to connect to an ESP32 and the connection is unstable with the repeating error `E (412486) micro_rdk::common::webrtc::ice: closing ice agent with error IceTransportClosed`, you have opened too many connections to the ESP32, which has a maximum of 3 connections by default.
8987
Make sure you only have one tab with your machine's page open to limit the number of connections to your ESP32.
9088

91-
### Linux port permissions
89+
## Linux port permissions
9290

9391
If a "Permission Denied" or similar port error occurs, first check the connection of the ESP32 to the machine's USB port.
9492
If connected and the error persists, run `sudo usermod -a -G dialout $USER` to add the current user to the `dialout` group, restart your terminal, and try again.
9593

96-
### MacOS executable permissions
94+
## MacOS executable permissions
9795

9896
When using a machine running a version of MacOS, the user is blocked from running the executable by default.
9997
To fix this, **Control+Click** the binary in Finder and then, in the following two prompts select **Open**.
10098
Close whatever terminal window this opens to be able to run the installer.
10199

102-
### Error: FlashConnect
100+
## Error: FlashConnect
103101

104102
This may occur because the serial port chosen if/when prompted is incorrect.
105103
However, if the correct port has been selected, try the following:
@@ -117,7 +115,7 @@ You can find additional assistance in the [Troubleshooting section](/manage/trou
117115

118116
{{< snippet "social.md" >}}
119117

120-
### Ubuntu not recognizing the microcontroller
118+
## Ubuntu not recognizing the microcontroller
121119

122120
If you’re trying to connect a microcontroller using serial port to an Ubuntu system and the computer doesn’t seem to be recognizing the microcontroller, check if the `brltty` service or its secondary service `brltty-udev` are active (`brltty` is a service installed by default that provides access to a braille display):
123121

0 commit comments

Comments
 (0)