arduino/arduino-app-cliPublic

NotificationsYou must be signed in to change notification settings
Fork2
Star5

Add Serial Number to Avahi Service for Board Deduplication#48

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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Jump to bottom

Open

mirkoCrobu wants to merge3 commits intomain

base:main

Choose a base branch

fromissue_694

Open

Add Serial Number to Avahi Service for Board Deduplication#48

mirkoCrobu wants to merge3 commits intomainfromissue_694

+64 −0

Conversation

Copy link

Contributor

mirkoCrobu commentedNov 5, 2025

Motivation

A board connected via both USB and Network currently shows up as two separate devices in the board list. This makes it difficult for a client application to know it is the same physical board.

We need a way to "deduplicate" these entries by providing a common identifier, allowing the client to show just one entry for that board.

Change description

A simple approach is to add the board's serial number to its Avahi service file. This change will be made at runtime when the EnableNetworkMode function is executed.

Specifically, we will add a new containing the serial number (e.g., serial_number=YOUR_SERIAL) to the board's .service file.

Additional Notes

Reviewer checklist

PR addresses a single concern.
PR title and description are properly filled.
Changes will be merged inmain.
Changes are covered by tests.
Logging is meaningful in case of troubleshooting.

mirkoCrobu requested review froma team andlucarin91

November 5, 2025 16:14

mirkoCrobu self-assigned this

Nov 6, 2025

lucarin91 requested changes

Nov 6, 2025

View reviewed changes

Copy link

Contributor

lucarin91 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

I didn't figure out that we needed to add another sudoers file for this feature, which I would avoid to do it. So I think we should change the approach here, and we could instead do that in a systemd unit that is triggered only on the first boot, e.g.,https://github.com/arduino/arduino-app-cli/blob/main/debian/arduino-app-cli/etc/systemd/system/arduino-burn-bootloader.service.
The Serial number of the board should not change, so we can do it just the first time you flash the board, and in there, you have all the permission to patch the Avahi service.

set serial number for network discovery at post install time

2d88451

mirkoCrobu force-pushed theissue_694 branch from30a0cf2 to2d88451Compare

November 7, 2025 14:16

adds space in a comment

af1ddb2

Copy link

ContributorAuthor

mirkoCrobu commentedNov 7, 2025

How to test it

Create the .deb and push it into the board
On the board
Be sure that/etc/avahi/services/arduino.service doesn't contain the serial number
Reboot the board
Check/etc/avahi/services/arduino.service: now you should see the serial number
Check that the .flag file exists: ls -l /var/lib/arduino/avahi_serial_configured.flag
Check the service status (should be active (exited)):systemctl status arduino-avahi-serial.service
Enable network mode:arduino-app-cli system network-mode enable
From your PC
Check the board list configs(you should the network information with serial number:
):arduino-cli board list --json

mirkoCrobu requested a review fromlucarin91

November 7, 2025 14:27

lucarin91 reviewed

Nov 7, 2025

View reviewed changes

debian/arduino-app-cli/etc/systemd/system/arduino-avahi-serial.service Outdated

		@@ -0,0 +1,17 @@
		[Unit]
		Description=Configure Avahi with board serial number
		After=avahi-daemon.service

Copy link

Contributor

lucarin91Nov 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

I would do it before not after

Copy link

ContributorAuthor

mirkoCrobuNov 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

I put it "after" to ensure I could find the file "/etc/avahi/services/arduino.service".
Also, we don't need to restart Avahi after modifying the file.
(Btw I change it in "Before")

Copy link

Contributor

lucarin91Nov 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

I put it "after" to ensure I could find the file "/etc/avahi/services/arduino.service".

The file should be always there

Also, we don't need to restart Avahi after modifying the file.

Not sure about that I think it need a restart

set script running before Avahi service

da65948

dido18 reviewed

Nov 7, 2025

View reviewed changes

debian/arduino-app-cli/DEBIAN/postinst


		systemctlenable arduino-app-cli
		systemctlenable arduino-burn-bootloader
		systemctlenable arduino-avahi-serial.service

Copy link

Contributor

dido18Nov 7, 2025•
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Is the .service suffix needed ?

Suggested change

	systemctl enable arduino-avahi-serial.service
	systemctl enable arduino-avahi-serial

lucarin91 reviewed

Nov 7, 2025

View reviewed changes

Copy link

Contributor

lucarin91 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

I would also add the disable command in postrm as for the other services

debian/arduino-app-cli/usr/sbin/arduino-avahi-serial.sh

Comment on lines +3 to +6

		# Configure Avahi with the serial number.
		# This operation is non-blocking: if it fails,
		# the script will exit with success in order to
		# not to interrupt the post-install process.

Copy link

Contributor

lucarin91Nov 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

I think this script should and could fail. If there is an issue, I would prefer that it start the next time instead of never

debian/arduino-app-cli/usr/sbin/arduino-avahi-serial.sh

Comment on lines +16 to +17

		echo"Warning: Serial number path not found at$SERIAL_NUMBER_PATH. Skipping.">&2
		exit 0

Copy link

Contributor

lucarin91Nov 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Suggested change

	echo"Warning: Serial number path not found at$SERIAL_NUMBER_PATH. Skipping.">&2
	exit0
	echo"Warning: Serial number path not found at$SERIAL_NUMBER_PATH">&2
	exit1

debian/arduino-app-cli/usr/sbin/arduino-avahi-serial.sh

Comment on lines +22 to +23

		echo"Warning: Target file$TARGET_FILE not found or not writable. Skipping.">&2
		exit 0

Copy link

Contributor

lucarin91Nov 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Suggested change

	echo"Warning: Target file$TARGET_FILE not found or not writable. Skipping.">&2
	exit0
	echo"Warning: Target file$TARGET_FILE not found or not writable.">&2
	exit1

debian/arduino-app-cli/usr/sbin/arduino-avahi-serial.sh

Comment on lines +29 to +30

		echo"Warning: Serial number file is empty. Skipping.">&2
		exit 0

Copy link

Contributor

lucarin91Nov 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Suggested change

	echo"Warning: Serial number file is empty. Skipping.">&2
	exit0
	echo"Warning: Serial number file is empty.">&2
	exit1

debian/arduino-app-cli/usr/sbin/arduino-avahi-serial.sh

Comment on lines +34 to +35

		echo"Serial number ($SERIAL_NUMBER) already configured. Skipping."
		exit 0

Copy link

Contributor

lucarin91Nov 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Suggested change

	echo"Serial number ($SERIAL_NUMBER) already configured. Skipping."
	exit0
	echo"Serial number ($SERIAL_NUMBER) already configured."
	exit1

debian/arduino-app-cli/usr/sbin/arduino-avahi-serial.sh

		exit 0
		fi

		SERIAL_NUMBER_ESCAPED=$(echo"$SERIAL_NUMBER"\| sed -e's/\\/\\\\/g' -e's/\//\\\//g' -e's/\&/\\\&/g')

Copy link

Contributor

lucarin91Nov 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

The serial number on the unoq is just a number I don't think you need to escape anything

debian/arduino-app-cli/usr/sbin/arduino-avahi-serial.sh

		sed -i"\#${MARKER_LINE}#i${NEW_LINE}""$TARGET_FILE"

		echo"Avahi configuration attempt finished."
		exit 0 No newline at end of file

Copy link

Contributor

lucarin91Nov 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Suggested change

exit 0

debian/arduino-app-cli/DEBIAN/postinst


		systemctlenable arduino-app-cli
		systemctlenable arduino-burn-bootloader
		systemctlenable arduino-avahi-serial.service

Copy link

Contributor

lucarin91Nov 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

nit

Suggested change

	systemctl enable arduino-avahi-serial.service
	systemctl enable arduino-avahi-serial

Labels

None yet

Movatterモバイル変換

Add Serial Number to Avahi Service for Board Deduplication#48

Are you sure you want to change the base?

Add Serial Number to Avahi Service for Board Deduplication#48

Conversation

mirkoCrobu commentedNov 5, 2025

Motivation

Change description

Additional Notes

Reviewer checklist

Uh oh!

lucarin91 left a comment

Choose a reason for hiding this comment

Uh oh!

mirkoCrobu commentedNov 7, 2025

How to test it

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dido18Nov 7, 2025• editedLoading Uh oh!There was an error while loading.Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lucarin91 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

dido18Nov 7, 2025•
edited
Loading