API reference

Permissions

Every permission identifier of the plugin, generated from permissions/.

Generated from permissions/default.toml and permissions/autogenerated/, which Tauri writes from the command list. How to use them in a capability: Permissions guide.

Default permission set

Identifier: serialplugin:default

Default permissions for the serialplugin: enumerate, open, read/write, watch/unwatch, port hotplug, AT session, exchange, and configure serial ports on desktop and Android.

It includes 46 permissions:

allow-managed-ports, allow-available-ports, allow-watch-ports, allow-unwatch-ports, allow-cancel-read, allow-close, allow-close-all, allow-force-close, allow-open, allow-read, allow-read-binary, allow-write, allow-write-binary, allow-capabilities, allow-watch, allow-unwatch, allow-bytes-to-read, allow-bytes-to-write, allow-clear-break, allow-clear-buffer, allow-read-carrier-detect, allow-read-clear-to-send, allow-read-data-set-ready, allow-read-ring-indicator, allow-set-baud-rate, allow-set-break, allow-set-data-bits, allow-set-flow-control, allow-set-parity, allow-set-stop-bits, allow-set-timeout, allow-write-data-terminal-ready, allow-write-request-to-send, allow-set-log-level, allow-get-log-level, allow-exchange, allow-exchange-binary, allow-cancel-exchange, allow-at, allow-at-phases, allow-send-sms-pdu, allow-configure-at-session, allow-enable-mux, allow-open-mux-channel, allow-disable-mux, allow-ble-scan

All permissions

IdentifierDescriptionIn default
serialplugin:allow-atEnables the at command without any pre-configured scope.✓
serialplugin:deny-atDenies the at command without any pre-configured scope.
serialplugin:allow-at-phasesEnables the at_phases command without any pre-configured scope.✓
serialplugin:deny-at-phasesDenies the at_phases command without any pre-configured scope.
serialplugin:allow-available-portsEnables the available_ports command without any pre-configured scope.✓
serialplugin:deny-available-portsDenies the available_ports command without any pre-configured scope.
serialplugin:allow-ble-scanEnables the ble_scan command without any pre-configured scope.✓
serialplugin:deny-ble-scanDenies the ble_scan command without any pre-configured scope.
serialplugin:allow-bytes-to-readEnables the bytes_to_read command without any pre-configured scope.✓
serialplugin:deny-bytes-to-readDenies the bytes_to_read command without any pre-configured scope.
serialplugin:allow-bytes-to-writeEnables the bytes_to_write command without any pre-configured scope.✓
serialplugin:deny-bytes-to-writeDenies the bytes_to_write command without any pre-configured scope.
serialplugin:allow-cancel-exchangeEnables the cancel_exchange command without any pre-configured scope.✓
serialplugin:deny-cancel-exchangeDenies the cancel_exchange command without any pre-configured scope.
serialplugin:allow-cancel-readEnables the cancel_read command without any pre-configured scope.✓
serialplugin:deny-cancel-readDenies the cancel_read command without any pre-configured scope.
serialplugin:allow-capabilitiesEnables the capabilities command without any pre-configured scope.✓
serialplugin:deny-capabilitiesDenies the capabilities command without any pre-configured scope.
serialplugin:allow-clear-breakEnables the clear_break command without any pre-configured scope.✓
serialplugin:deny-clear-breakDenies the clear_break command without any pre-configured scope.
serialplugin:allow-clear-bufferEnables the clear_buffer command without any pre-configured scope.✓
serialplugin:deny-clear-bufferDenies the clear_buffer command without any pre-configured scope.
serialplugin:allow-closeEnables the close command without any pre-configured scope.✓
serialplugin:deny-closeDenies the close command without any pre-configured scope.
serialplugin:allow-close-allEnables the close_all command without any pre-configured scope.✓
serialplugin:deny-close-allDenies the close_all command without any pre-configured scope.
serialplugin:allow-configure-at-sessionEnables the configure_at_session command without any pre-configured scope.✓
serialplugin:deny-configure-at-sessionDenies the configure_at_session command without any pre-configured scope.
serialplugin:allow-disable-muxEnables the disable_mux command without any pre-configured scope.✓
serialplugin:deny-disable-muxDenies the disable_mux command without any pre-configured scope.
serialplugin:allow-enable-muxEnables the enable_mux command without any pre-configured scope.✓
serialplugin:deny-enable-muxDenies the enable_mux command without any pre-configured scope.
serialplugin:allow-exchangeEnables the exchange command without any pre-configured scope.✓
serialplugin:deny-exchangeDenies the exchange command without any pre-configured scope.
serialplugin:allow-exchange-binaryEnables the exchange_binary command without any pre-configured scope.✓
serialplugin:deny-exchange-binaryDenies the exchange_binary command without any pre-configured scope.
serialplugin:allow-force-closeEnables the force_close command without any pre-configured scope.✓
serialplugin:deny-force-closeDenies the force_close command without any pre-configured scope.
serialplugin:allow-get-log-levelEnables the get_log_level command without any pre-configured scope.✓
serialplugin:deny-get-log-levelDenies the get_log_level command without any pre-configured scope.
serialplugin:allow-managed-portsEnables the managed_ports command without any pre-configured scope.✓
serialplugin:deny-managed-portsDenies the managed_ports command without any pre-configured scope.
serialplugin:allow-openEnables the open command without any pre-configured scope.✓
serialplugin:deny-openDenies the open command without any pre-configured scope.
serialplugin:allow-open-mux-channelEnables the open_mux_channel command without any pre-configured scope.✓
serialplugin:deny-open-mux-channelDenies the open_mux_channel command without any pre-configured scope.
serialplugin:allow-readEnables the read command without any pre-configured scope.✓
serialplugin:deny-readDenies the read command without any pre-configured scope.
serialplugin:allow-read-binaryEnables the read_binary command without any pre-configured scope.✓
serialplugin:deny-read-binaryDenies the read_binary command without any pre-configured scope.
serialplugin:allow-read-carrier-detectEnables the read_carrier_detect command without any pre-configured scope.✓
serialplugin:deny-read-carrier-detectDenies the read_carrier_detect command without any pre-configured scope.
serialplugin:allow-read-clear-to-sendEnables the read_clear_to_send command without any pre-configured scope.✓
serialplugin:deny-read-clear-to-sendDenies the read_clear_to_send command without any pre-configured scope.
serialplugin:allow-read-data-set-readyEnables the read_data_set_ready command without any pre-configured scope.✓
serialplugin:deny-read-data-set-readyDenies the read_data_set_ready command without any pre-configured scope.
serialplugin:allow-read-ring-indicatorEnables the read_ring_indicator command without any pre-configured scope.✓
serialplugin:deny-read-ring-indicatorDenies the read_ring_indicator command without any pre-configured scope.
serialplugin:allow-send-sms-pduEnables the send_sms_pdu command without any pre-configured scope.✓
serialplugin:deny-send-sms-pduDenies the send_sms_pdu command without any pre-configured scope.
serialplugin:allow-set-baud-rateEnables the set_baud_rate command without any pre-configured scope.✓
serialplugin:deny-set-baud-rateDenies the set_baud_rate command without any pre-configured scope.
serialplugin:allow-set-breakEnables the set_break command without any pre-configured scope.✓
serialplugin:deny-set-breakDenies the set_break command without any pre-configured scope.
serialplugin:allow-set-data-bitsEnables the set_data_bits command without any pre-configured scope.✓
serialplugin:deny-set-data-bitsDenies the set_data_bits command without any pre-configured scope.
serialplugin:allow-set-flow-controlEnables the set_flow_control command without any pre-configured scope.✓
serialplugin:deny-set-flow-controlDenies the set_flow_control command without any pre-configured scope.
serialplugin:allow-set-log-levelEnables the set_log_level command without any pre-configured scope.✓
serialplugin:deny-set-log-levelDenies the set_log_level command without any pre-configured scope.
serialplugin:allow-set-parityEnables the set_parity command without any pre-configured scope.✓
serialplugin:deny-set-parityDenies the set_parity command without any pre-configured scope.
serialplugin:allow-set-stop-bitsEnables the set_stop_bits command without any pre-configured scope.✓
serialplugin:deny-set-stop-bitsDenies the set_stop_bits command without any pre-configured scope.
serialplugin:allow-set-timeoutEnables the set_timeout command without any pre-configured scope.✓
serialplugin:deny-set-timeoutDenies the set_timeout command without any pre-configured scope.
serialplugin:allow-unwatchEnables the unwatch command without any pre-configured scope.✓
serialplugin:deny-unwatchDenies the unwatch command without any pre-configured scope.
serialplugin:allow-unwatch-portsEnables the unwatch_ports command without any pre-configured scope.✓
serialplugin:deny-unwatch-portsDenies the unwatch_ports command without any pre-configured scope.
serialplugin:allow-watchEnables the watch command without any pre-configured scope.✓
serialplugin:deny-watchDenies the watch command without any pre-configured scope.
serialplugin:allow-watch-portsEnables the watch_ports command without any pre-configured scope.✓
serialplugin:deny-watch-portsDenies the watch_ports command without any pre-configured scope.
serialplugin:allow-writeEnables the write command without any pre-configured scope.✓
serialplugin:deny-writeDenies the write command without any pre-configured scope.
serialplugin:allow-write-binaryEnables the write_binary command without any pre-configured scope.✓
serialplugin:deny-write-binaryDenies the write_binary command without any pre-configured scope.
serialplugin:allow-write-data-terminal-readyEnables the write_data_terminal_ready command without any pre-configured scope.✓
serialplugin:deny-write-data-terminal-readyDenies the write_data_terminal_ready command without any pre-configured scope.
serialplugin:allow-write-request-to-sendEnables the write_request_to_send command without any pre-configured scope.✓
serialplugin:deny-write-request-to-sendDenies the write_request_to_send command without any pre-configured scope.