CoreExternalDevice
This API is partially documented or under construction.
Overview​
Core External Device API implementation for Synology NAS.
Covers Bluetooth, printer (driver, network, USB, OAuth), and storage (expansion unit, settings) endpoints not handled by other modules.
Methods​
bluetooth_get​
Get Bluetooth adapter status.
Internal API​
SYNO.Core.ExternalDevice.Bluetooth
Returns​
dict[str, object] or str
Result of the bluetooth get operation.
bluetooth_set​
Enable or disable the Bluetooth adapter.
Internal API​
SYNO.Core.ExternalDevice.Bluetooth
Parameters​
enable bool
The enable value.
Returns​
dict[str, object] or str
Result of the bluetooth set operation.
bluetooth_device_list​
List discovered Bluetooth devices.
Internal API​
SYNO.Core.ExternalDevice.Bluetooth.Device
Returns​
dict[str, object] or str
Result of the bluetooth device list operation.
bluetooth_device_get​
Get information for a specific Bluetooth device.
Internal API​
SYNO.Core.ExternalDevice.Bluetooth.Device
Parameters​
device_id str
The device id value.
Returns​
dict[str, object] or str
Result of the bluetooth device get operation.
bluetooth_device_connect​
Connect to a Bluetooth device.
Internal API​
SYNO.Core.ExternalDevice.Bluetooth.Device
Parameters​
device_id str
The device id value.
Returns​
dict[str, object] or str
Result of the bluetooth device connect operation.
bluetooth_device_disconnect​
Disconnect a Bluetooth device.
Internal API​
SYNO.Core.ExternalDevice.Bluetooth.Device
Parameters​
device_id str
The device id value.
Returns​
dict[str, object] or str
Result of the bluetooth device disconnect operation.
bluetooth_settings_get​
Get Bluetooth settings.
Internal API​
SYNO.Core.ExternalDevice.Bluetooth.Settings
Returns​
dict[str, object] or str
Result of the bluetooth settings get operation.
bluetooth_settings_set​
Set Bluetooth settings.
Internal API​
SYNO.Core.ExternalDevice.Bluetooth.Settings
Parameters​
discoverable str
The discoverable value.
name str
The name value.
Returns​
dict[str, object] or str
Result of the bluetooth settings set operation.
default_permission_get​
Get default permission settings for external devices.
Internal API​
SYNO.Core.ExternalDevice.DefaultPermission
Returns​
dict[str, object] or str
Result of the default permission get operation.
default_permission_set​
Set default permission for external devices.
Internal API​
SYNO.Core.ExternalDevice.DefaultPermission
Parameters​
permission str
The permission value.
Returns​
dict[str, object] or str
Result of the default permission set operation.
printer_list​
List all printers.
Internal API​
SYNO.Core.ExternalDevice.Printer
Returns​
dict[str, object] or str
Result of the printer list operation.
printer_get​
Get printer information.
Internal API​
SYNO.Core.ExternalDevice.Printer
Parameters​
printer_id str
The printer id value.
Returns​
dict[str, object] or str
Result of the printer get operation.
printer_clean​
Clean the print queue for a printer.
Internal API​
SYNO.Core.ExternalDevice.Printer
Parameters​
printer_id str
The printer id value.
Returns​
dict[str, object] or str
Result of the printer clean operation.
printer_driver_list​
List available printer drivers.
Internal API​
SYNO.Core.ExternalDevice.Printer.Driver
Returns​
dict[str, object] or str
Result of the printer driver list operation.
printer_driver_get​
Get a specific printer driver.
Internal API​
SYNO.Core.ExternalDevice.Printer.Driver
Parameters​
driver_id str
The driver id value.
Returns​
dict[str, object] or str
Result of the printer driver get operation.
printer_network_list​
List network printers.
Internal API​
SYNO.Core.ExternalDevice.Printer.Network
Returns​
dict[str, object] or str
Result of the printer network list operation.
printer_network_create​
Add a network printer.
Internal API​
SYNO.Core.ExternalDevice.Printer.Network
Parameters​
host str
The host value.
port int
The port value.
driver_id str
The driver id value.
Returns​
dict[str, object] or str
Result of the printer network create operation.
printer_network_delete​
Remove a network printer.
Internal API​
SYNO.Core.ExternalDevice.Printer.Network
Parameters​
printer_id str
The printer id value.
Returns​
dict[str, object] or str
Result of the printer network delete operation.
printer_network_host_list​
List network printer hosts discovered on the network.
Internal API​
SYNO.Core.ExternalDevice.Printer.Network.Host
Returns​
dict[str, object] or str
Result of the printer network host list operation.
printer_oauth_get​
Get OAuth settings for cloud printing.
Internal API​
SYNO.Core.ExternalDevice.Printer.OAuth
Returns​
dict[str, object] or str
Result of the printer oauth get operation.
printer_oauth_set​
Set OAuth token for cloud printing.
Internal API​
SYNO.Core.ExternalDevice.Printer.OAuth
Parameters​
token str
The token value.
Returns​
dict[str, object] or str
Result of the printer oauth set operation.
printer_usb_list​
List USB printers.
Internal API​
SYNO.Core.ExternalDevice.Printer.USB
Returns​
dict[str, object] or str
Result of the printer usb list operation.
printer_usb_get​
Get USB printer information.
Internal API​
SYNO.Core.ExternalDevice.Printer.USB
Parameters​
printer_id str
The printer id value.
Returns​
dict[str, object] or str
Result of the printer usb get operation.
printer_usb_release​
Release a USB printer from the server.
Internal API​
SYNO.Core.ExternalDevice.Printer.USB
Parameters​
printer_id str
The printer id value.
Returns​
dict[str, object] or str
Result of the printer usb release operation.
storage_eunit_list​
List connected expansion units.
Internal API​
SYNO.Core.ExternalDevice.Storage.EUnit
Returns​
dict[str, object] or str
Result of the storage eunit list operation.
storage_eunit_get​
Get expansion unit details.
Internal API​
SYNO.Core.ExternalDevice.Storage.EUnit
Parameters​
unit_id str
The unit id value.
Returns​
dict[str, object] or str
Result of the storage eunit get operation.
storage_setting_get​
Get external storage settings.
Internal API​
SYNO.Core.ExternalDevice.Storage.Setting
Returns​
dict[str, object] or str
Result of the storage setting get operation.
storage_setting_set​
Set external storage settings.
Internal API​
SYNO.Core.ExternalDevice.Storage.Setting
Parameters​
auto_format str
The auto format value.
auto_mount str
The auto mount value.
Returns​
dict[str, object] or str
Result of the storage setting set operation.