Pular para o conteúdo principal

Dispositivo & Sistema

Visão geral dos endpoints​

MethodPathPurpose
GET/system/device-infoObter número de série do dispositivo, versão do firmware, modelo da placa do sensor e da placa base
GET/system/resource-infoObter uso de CPU, NPU, memória e armazenamento
GET/system/timeObter hora do sistema, fuso horário e configuração de NTP
PUT/system/timeDefinir hora do sistema
GET/system/batteryObter status da bateria
GET/system/checkVerificar se é o primeiro login
GET/system/sshConsultar status de execução do SSH
POST/system/sshIniciar ou parar o SSH
GET/system/secureConsultar status do HTTPS
POST/system/secureAtivar ou desativar HTTPS
GET/config/exportExportar configuração do dispositivo
POST/config/uploadImportar configuração do dispositivo
POST/system/rebootReiniciar o dispositivo
POST/system/factory-resetRestaurar configurações de fábrica

Obter informações do dispositivo​

GET /system/device-info

Resposta:

{
  "sSerialNumber": "RC1126B-20240101-001",
  "sFirmwareVersion": "V1.0.10",
  "sSensorModel": "SC850SL",
  "sBasePlateModel": "Base Board-V1.0,Expand Board-V1.0"
}
FieldDescription
sSerialNumberNúmero de série do dispositivo
sFirmwareVersionVersão do firmware
sSensorModelModelo da placa do sensor
sBasePlateModelModelo da placa base

Obter status dos recursos do sistema​

GET /system/resource-info

Resposta:

{
  "iCpuUsage": 12,
  "iNpuUsage": 69,
  "sMem": {
    "iMemTotal": 1.94,
    "iMemUsage": 33,
    "iMemUsed": 0.65
  },
  "sStorage": {
    "iStorageTotal": 11.29,
    "iStorageUsage": 37,
    "iStorageUsed": 4.22
  }
}
FieldDescription
iCpuUsagePorcentagem de uso da CPU
iNpuUsagePorcentagem de uso da NPU
sMem.iMemTotalMemória total
sMem.iMemUsedMemória utilizada
sMem.iMemUsagePorcentagem de uso da memória
sStorage.iStorageTotalArmazenamento total
sStorage.iStorageUsedArmazenamento utilizado
sStorage.iStorageUsagePorcentagem de uso do armazenamento

Hora do sistema​

Obter hora do sistema​

GET /system/time

Resposta:

{
  "sMethod": "ntp",
  "dNtpConfig": {
    "sAddress": "pool.ntp.org",
    "sPort": "123",
    "status": 0
  },
  "iTimestamp": 1784083074,
  "sTimezone": "Asia/Shanghai",
  "sTz": "UTC+8"
}
FieldDescription
sMethodFonte de tempo, ntp ou manual
dNtpConfig.sAddressEndereço do servidor NTP
dNtpConfig.sPortPorta NTP
dNtpConfig.statusStatus do NTP, 0 significa sucesso
iTimestampTimestamp Unix em segundos
sTimezoneCidade do fuso horário
sTzFuso horário, por exemplo UTC+8

Definir hora do sistema​

PUT /system/time

Corpo da requisição em modo NTP:

{
  "sMethod": "ntp",
  "dNtpConfig": {
    "sAddress": "pool.ntp.org",
    "sPort": "123"
  },
  "sTimezone": "Asia/Shanghai",
  "sTz": "UTC+8"
}

Corpo da requisição em modo manual:

{
  "sMethod": "manual",
  "iTimestamp": 1784083074,
  "sTimezone": "Asia/Shanghai",
  "sTz": "UTC+8"
}

Resposta:

{
  "iTimestamp": 1784083074,
  "sTimezone": "Asia/Shanghai",
  "sTz": "UTC+8"
}

Status da bateria​

GET /system/battery

Resposta:

{
  "isAttached": true,
  "displaySteps": 0,
  "totalSteps": 5,
  "isCharging": false
}
FieldDescription
isAttachedIndica se uma bateria está conectada
displayStepsNível atual da bateria em etapas
totalStepsTotal de etapas de nível da bateria
isChargingIndica se a bateria está carregando

Verificar primeiro login​

GET /system/check

Resposta:

{
  "bFirst": false
}

bFirst=true indica que o dispositivo está no fluxo de primeiro login e a senha padrão deve ser alterada.

SSH​

Consultar status do SSH​

GET /system/ssh

Resposta:

{
  "bRunning": true
}

Iniciar ou parar SSH​

POST /system/ssh

Corpo da requisição:

{
  "bRunning": true
}
FieldDescription
bRunningtrue para iniciar o SSH, false para parar

HTTPS​

Consultar status do HTTPS​

GET /system/secure

Resposta:

{
  "sEnable": true
}

Ativar ou desativar HTTPS​

POST /system/secure

Corpo da requisição:

{
  "sEnable": true
}

Resposta:

{
  "code": 0,
  "message": "Settings applied successfully"
}

Após ativar o HTTPS, use https://<DEVICE_IP> para acessos posteriores.

Gerenciamento de configuração​

Exportar configuração​

GET /config/export

Resposta:

{
  "size": 35116544,
  "url": "/download/config.tar"
}
FieldDescription
sizeTamanho do arquivo de configuração
urlCaminho de download; adicione o IP do dispositivo no início para obter uma URL completa

URL de download:

http://<DEVICE_IP>/download/config.tar

Importar configuração​

POST /config/upload

A importação da configuração substitui as configurações atuais do dispositivo. Exporte primeiro a configuração atual como backup.

Reiniciar​

POST /system/reboot

Resposta:

{
  "code": 0,
  "message": "success"
}

O dispositivo será reiniciado e a conexão atual será perdida. Aguarde o dispositivo voltar a ficar online antes de continuar.

Restauração de fábrica​

A restauração de fábrica requer confirmação em duas etapas.

Etapa 1:

POST /system/factory-reset

Resposta:

{
  "code": 0,
  "sConfirmToken": "adfagghvshf"
}

Etapa 2, envie o token de confirmação dentro do seu período de validade:

POST /system/factory-reset

Corpo da requisição:

{
  "sConfirmToken": "adfagghvshf"
}

Resposta:

{
  "code": 0,
  "message": "success"
}

A restauração de fábrica apaga toda a configuração do dispositivo. Certifique-se de ter um backup antes de prosseguir.

Suporte técnico e discussão sobre o produto​

Obrigado por escolher nossos produtos! Estamos aqui para oferecer diversos tipos de suporte para garantir que sua experiência com nossos produtos seja a mais tranquila possível. Oferecemos vários canais de comunicação para atender a diferentes preferências e necessidades.

Loading Comments...