Entidad de configuración del dispositivo (v3)
1 min
La entidad Device Setup contiene las siguientes propiedades requeridas:
- versión string required: Este valor debe ser "3.0.0"
- _id string required: El id del objeto device Setup. Esto solo es necesario para una llamada “PUT” (no “POST”).
- bDeploy object required: Un Entidad de información de propiedad (v3)
- setupType string required: El tipo de player Setup, que es uno de "legacyLfn", "localToBsn", "lfn", "sfn", "partnerApplication", "standalone" o "bsn"
- bsnDeviceRegistrationTokenEntity object required: Una Entidad de token (v3).
- zona horaria string required: La zona horaria (por ejemplo, "PST"). Consulte esta página para conocer las opciones de zona horaria disponibles.
- bsnGroupName string required: Si el tipo de configuración es BSN, esto es obligatorio. El nombre del grupo BSN.Cloud al que se asignarán los dispositivos aprovisionados. Este valor usa de forma predeterminada el grupo "Default" si no se proporciona el valor.
- red object required: La Entidad de red (v3). Esto contendrá valores predeterminados a menos que el usuario especifique parámetros.
También se pueden usar estas propiedades opcionales:
- actualizacionesDeFirmwarePorFamilia object optional: La Entidad FirmwareUpdatebyFamily (v3). Si se requiere una actualización de firmware con su configuración, este campo es obligatorio.
- firmwareUpdateType string optional: El tipo de actualización de firmware, que es uno de "different", "newer", "save" y "standard". El tipo predeterminado es “standard”. Consulte firmwareUpdateDifferentTargetFileName, firmwareUpdateNewerTargetFileName, firmwareUpdateSaveTargetFileName, y firmwareUpdateStandardTargetFileName en Entidad FirmwareUpdatebyFamily (v3) para obtener más información sobre estos tipos y ejemplos de uso. Si se requiere una actualización de firmware con su configuración, este campo es obligatorio.
- enableSerialDebugging bool optional: False es el valor predeterminado. Si es true, la depuración serial está habilitada.
- enableSystemLogDebugging bool optional: False es el valor predeterminado. Si es true, la depuración del registro del sistema está habilitada.
- remoteDwsEnabled bool optional: False es el valor predeterminado. Si es true, el DWS remoto está habilitado en el reproductor y se puede acceder a él de forma remota.
- dwsEnabled bool optional: False es el valor predeterminado. Si es true, el DWS está habilitado en la red local del reproductor.
- dwsPassword string optional: La contraseña de DWS (puede ser una cadena vacía). Aunque esto no es obligatorio, debe agregar esta contraseña por motivos de seguridad. La contraseña predeterminada es el número de serie del reproductor.
- lwsEnabled bool optional: False es el valor predeterminado. Si es true, el LWS está habilitado.
- lwsUserName string optional: El nombre de usuario del servidor LWS (puede ser una cadena vacía)
- lwsPassword string optional: La contraseña para el servidor LWS (puede ser una cadena vacía)
- lwsEnableUpdateNotifications bool optional: False es el valor predeterminado. Si es true, las notificaciones de actualización están habilitadas en el LWS.
- bsnCloudEnabled bool optional: El valor predeterminado, true, indica que BSN.Cloud está habilitado.
- deviceName string optional: El nombre de dispositivo definido por el usuario para dispositivos aprovisionados con el paquete Device Setup. Puede ser una cadena vacía.
- deviceDescription string optional: La descripción definida por el usuario proporcionada a los dispositivos aprovisionados con el paquete Device Setup. Puede ser una cadena vacía.
- unitNamingMethod string optional: Ya sea "appendUnitIDToUnitName" o "unitNameOnly", lo que determina si se agrega o no el número de serie al nombre del dispositivo.
- timeBetweenNetConnects int optional: Con qué frecuencia el autorun verifica contenido (en segundos). El valor predeterminado es 300 segundos (5 minutos).
- timeBetweenHeartbeats int optional: Con qué frecuencia el reproductor informa del estado a BSN (en segundos). El valor predeterminado es 900 segundos (15 minutos).
- sfnWebFolderUrl string optional: Esto solo es necesario si el tipo de configuración es SFN. La dirección URL de la carpeta accesible mediante web que contiene la presentación simple file networking. Esta puede ser una cadena vacía.
- sfnEnableBasicAuthentication bool optional: Si esto es verdadero, la contraseña y el nombre de usuario son obligatorios. False es el valor predeterminado.
- sfnUserName string: El nombre de usuario para el servidor de archivos SFN, que solo es obligatorio si el servidor SFN está protegido con contraseña. Esta cadena puede estar vacía.
- sfnPassword string: La contraseña para el servidor SFN. Esta cadena puede estar vacía.
- playbackLoggingEnabled bool optional: False es el valor predeterminado. Si es verdadero, el registro de reproducción está habilitado.
- eventLoggingEnabled bool optional: False es el valor predeterminado. Si es verdadero, el registro de eventos está habilitado.
- diagnosticLoggingEnabled bool optional: False es el valor predeterminado. Si es verdadero, el registro de diagnóstico está habilitado.
- stateLoggingEnabled bool optional: False es el valor predeterminado. Si es verdadero, el registro de estado está habilitado.
- variableLoggingEnabled bool optional: False es el valor predeterminado. Si es verdadero, el registro de variables está habilitado.
- uploadLogFilesAtBoot bool optional: False es el valor predeterminado. Si es verdadero, los archivos de registro se cargarán al iniciar el reproductor.
- uploadLogFilesAtSpecificTime bool optional: False es el valor predeterminado. Si es verdadero, los archivos de registro se cargarán a una hora específica.
- uploadLogFilesTime int: La hora a la que se cargarán los archivos de registro, si corresponde, en minutos. Esto es obligatorio si uploadLogFilesAtSpecificTime está habilitado.
- logHandlerUrl string optional: La URL del controlador de registros personalizado a la que se cargan los registros. Esto solo está habilitado para simple file networking (de lo contrario, será una cadena vacía).
- enableRemoteSnapshot bool optional: False es el valor predeterminado. Si es verdadero, la instantánea remota está habilitada. Los siguientes parámetros son obligatorios si habilita este booleano:
- remoteSnapshotInterval int: La cantidad de minutos de espera entre la captura de cada instantánea. Zero es el valor predeterminado, pero este valor debe establecerse si enableRemoteSnapshot es verdadero.
- remoteSnapshotMaxImages int: La cantidad máxima de imágenes de instantáneas que se guardarán. Los valores posibles son de 1 a 100.
- remoteSnapshotJpegQualityLevel int: El nivel de calidad JPEG para la instantánea remota, en una escala del 1 al 100
- remoteSnapshotScreenOrientation string: La orientación de la pantalla ("Landscape", "PortraitBottomRight" o "PortraitBottomLeft")
- remoteSnapshotHandlerUrl string: La URL para el controlador de instantáneas remotas
- idleScreenColor object optional: Un objeto con propiedades RGBA. El color predeterminado es negro.
- networkDiagnosticsEnabled bool optional: False es el valor predeterminado. Si es true, los diagnósticos de red están habilitados. Esto debe estar habilitado para poder habilitar testEthernetEnabled, testWirelessEnabled, o testInternetEnabled:
- testEthernetEnabled bool: False es el valor predeterminado. Si es true, la prueba de ethernet durante la configuración está habilitada.
- testWirelessEnabled bool: False es el valor predeterminado. Si es true, la prueba inalámbrica durante la configuración está habilitada.
- testInternetEnabled bool: False es el valor predeterminado. Si es true, la prueba de internet durante la configuración está habilitada.
- useCustomSplashScreen bool optional: False es el valor predeterminado. Si es true, se utilizará una pantalla de presentación personalizada.
- BrightWallName string optional: El nombre de la configuración de BrightWall
- BrightWallScreenNumber string optional: El número de pantalla de BrightWall
- contentDownloadsRestricted bool optional: False es el valor predeterminado. Si es true, las descargas de contenido están restringidas para SFN y BSN. Si el valor es true, los siguientes campos son obligatorios:
- contentDownloadRangeStart int: La hora de inicio en la que el contenido puede descargarse, de 00:00 a 23:59 (en minutos)
- contentDownloadRangeEnd int: La hora de finalización en la que el contenido puede descargarse, de 00:00 a 23:59 (en minutos)
- usbUpdatePassword string optional: La contraseña para la función de actualización USB
- inheritNetworkProperties bool optional: False es el valor predeterminado (utilizará las propiedades de red del archivo de configuración del dispositivo). Si es true, la configuración utilizará los ajustes actuales de configuración de red del reproductor.
- internalCaArtifacts internalCaArtifacts[] optional: Una lista de objetos de certificado. Cada objeto tiene un nombre y un recurso (el objeto de archivo del certificado). Esto puede ser un objeto vacío.
Ejemplo
La entidad Entidad FirmwareUpdatebyFamily (v3) no está incluida en este ejemplo, ya que solo es necesaria para las actualizaciones de firmware.
{
"version":"3.0.0",
"_id":"",
"bDeploy":{
"username":"[email protected]",
"networkName":"admin",
"packageName":"test2023"
},
"firmwareUpdateType":"standard",
"setupType":"standalone",
"bsnDeviceRegistrationTokenEntity":{
"token":"{{token}}",
"scope":"cert",
"validFrom":"2023-01-26T23:21:48.000Z",
"validTo":"2025-01-25T23:21:48.000Z"
},
"enableSerialDebugging":false,
"enableSystemLogDebugging":false,
"remoteDwsEnabled":true,
"dwsEnabled":false,
"dwsPassword":"",
"lwsEnabled":true,
"lwsUserName":"",
"lwsPassword":"",
"lwsEnableUpdateNotifications":true,
"bsnCloudEnabled":true,
"deviceName":"",
"deviceDescription":"",
"unitNamingMethod":"appendUnitIDToUnitName",
"timeZone":"PST",
"bsnGroupName":"Default",
"timeBetweenNetConnects":300,
"timeBetweenHeartbeats":900,
"sfnWebFolderUrl":"",
"sfnUserName":"",
"sfnPassword":"",
"sfnEnableBasicAuthentication":false,
"playbackLoggingEnabled":false,
"eventLoggingEnabled":false,
"diagnosticLoggingEnabled":false,
"stateLoggingEnabled":false,
"variableLoggingEnabled":false,
"uploadLogFilesAtBoot":false,
"uploadLogFilesAtSpecificTime":false,
"uploadLogFilesTime":0,
"logHandlerUrl":"",
"enableRemoteSnapshot":false,
"remoteSnapshotInterval":15,
"remoteSnapshotMaxImages":5,
"remoteSnapshotJpegQualityLevel":50,
"remoteSnapshotScreenOrientation":"Landscape",
"remoteSnapshotHandlerUrl":"",
"idleScreenColor":{
"r":0,
"g":0,
"b":0,
"a":1
},
"networkDiagnosticsEnabled":false,
"testEthernetEnabled":false,
"testWirelessEnabled":false,
"testInternetEnabled":false,
"useCustomSplashScreen":false,
"BrightWallName":"",
"BrightWallScreenNumber":"",
"contentDownloadsRestricted":false,
"contentDownloadRangeStart":0,
"contentDownloadRangeEnd":0,
"heartbeatsRestricted":false,
"heartbeatsRangeStart":0,
"heartbeatsRangeEnd":0,
"usbUpdatePassword":"",
"inheritNetworkProperties":false,
"internalCaArtifacts":[
],
"network":{
"timeServers":[
"http://time.brightsignnetwork.com"
],
"hostname":null,
"dns":null,
"proxyServer":null,
"proxyBypass":null,
"interfaces":[
{
"id":"wired_eth0",
"name":"eth0",
"type":"Ethernet",
"proto":"DHCPv4",
"ip":[
],
"gateway":null,
"dns":[
],
"rateLimitDuringInitialDownloads":0,
"rateLimitInsideContentDownloadWindow":0,
"rateLimitOutsideContentDownloadWindow":null,
"contentDownloadEnabled":true,
"textFeedsDownloadEnabled":true,
"mediaFeedsDownloadEnabled":true,
"healthReportingEnabled":true,
"logsUploadEnabled":true,
"wpaSettings":{
"enableWPAEnterpriseAuthentication":false,
"wpaEnterpriseVariant":"WPAEnterpriseEapTls",
"eapCertificateType":"WPAEapTlsPKCS",
"eapCertificateFile":null,
"eapCertificatePassphrase":"",
"eapPemOrDerKeyFile":null,
"peapUsername":"",
"peapPassphrase":"",
"caCertificateFile":null
}
},
{
"id":"wireless_wlan0",
"name":"wlan0",
"type":"WiFi",
"proto":"DHCPv4",
"ip":[
],
"gateway":null,
"dns":[
],
"rateLimitDuringInitialDownloads":null,
"rateLimitInsideContentDownloadWindow":null,
"rateLimitOutsideContentDownloadWindow":null,
"contentDownloadEnabled":true,
"textFeedsDownloadEnabled":true,
"mediaFeedsDownloadEnabled":true,
"healthReportingEnabled":true,
"logsUploadEnabled":true,
"ssid":"dadmom",
"passphrase":"",
"security":{
"authentication":{
"mode":"Shared",
"passphrase":"{{passphrase}}"
},
"encryption":{
"mode":"TKIP, CCMP"
}
},
"wpaSettings":{
"enableWPAEnterpriseAuthentication":false,
"wpaEnterpriseVariant":"WPAEnterpriseEapTls",
"eapCertificateType":"WPAEapTlsPKCS",
"eapCertificateFile":null,
"eapCertificatePassphrase":"",
"eapPemOrDerKeyFile":null,
"peapUsername":"",
"peapPassphrase":"",
"caCertificateFile":null
}
}
]
}
}