Справочник API

Обнаружение поблизости

Поддержку функций проверяйте через app.capabilities, доступ — через app.access и разрешения хоста. Замените тестовые значения перед вызовом.

Device A
UDP → 224.0.0.251:5353
Device B

PTR query

UDP · DNS

Многоадресная рассылка IPv4, а не широковещательная IP: 224.0.0.251:5353. A выполняет поиск каждые 5 с; B также объявляет себя при запуске и каждые 60 с. Ответы PTR включают SRV, TXT и A. Во всплывающих окнах показаны декодированные искусственные записи DNS.

Наведите указатель на поле или коснитесь его
1 / 3

Определения типов

graphql
type Mutation {
  acquireMdnsDebugSession(token: String!): Boolean!
  releaseMdnsDebugSession(token: String!): Boolean!
  startDiscovery: Boolean!
  stopDiscovery: Boolean!
}

type Query {
  isDiscovering: Boolean!
  mdnsState: MdnsState!
  nearbyDevices: [NearbyDevice!]!
  parsePairingQrCode(code: String!): NearbyDevice
}

enum DeviceType {
	COMPUTER
	PHONE
	TABLET
	TV
	NAS
	OTHER
}

enum DiscoveryMethod {
	LAN
	BLE
	QR
}

scalar Instant

scalar Long

type MdnsActivity {
	time: Instant!
	event: String!
	detail: String!
}

type MdnsPacket {
	time: Instant!
	direction: MdnsPacketDirection!
	srcIp: String!
	srcPort: Int!
	dstIp: String!
	dstPort: Int!
	size: Long!
	summary: String!
	detail: String!
}

enum MdnsPacketDirection {
	IN
	OUT
}

type MdnsService {
	serviceType: String!
	instanceName: String!
	instanceFqdn: String!
	hostname: String!
	port: Int!
	txtRecords: [String!]!
	ips: [String!]!
	ip6s: [String!]!
	complete: Boolean!
}

type MdnsState {
	runtimeId: String!
	packetsIn: [MdnsPacket!]!
	packetsOut: [MdnsPacket!]!
	revision: Long!
	running: Boolean!
	scanning: Boolean!
	services: [MdnsService!]!
	activity: [MdnsActivity!]!
}

type NearbyDevice {
	id: ID!
	name: String!
	ips: [String!]!
	port: Int!
	remoteAccess: Boolean
	signaturePublicKey: String!
	deviceType: DeviceType!
	version: String!
	platform: String!
	discoveryMethods: [DiscoveryMethod!]!
	bestIp: String!
	status: PeerStatus!
	lastSeen: Instant!
}

enum PeerStatus {
	PAIRED
	UNPAIRED
	CHANNEL
}

Операции

mutation

acquireMdnsDebugSession

Открыть сеанс отладки mDNS с UUID-токеном вызывающей стороны. Требуется HTTP_SERVER; освободите сеанс при закрытии страницы.

graphql
mutation acquireMdnsDebugSession($token: String!) {
  acquireMdnsDebugSession(token: $token)
}
mutation

releaseMdnsDebugSession

Освободить сеанс отладки mDNS по соответствующему токену. Требуется HTTP_SERVER.

graphql
mutation releaseMdnsDebugSession($token: String!) {
  releaseMdnsDebugSession(token: $token)
}
mutation

startDiscovery

Запускает обнаружение устройств.

graphql
mutation startDiscovery {
  startDiscovery
}
mutation

stopDiscovery

Останавливает обнаружение устройств.

graphql
mutation stopDiscovery {
  stopDiscovery
}
query

isDiscovering

Показывает, выполняется ли сейчас поиск устройств.

graphql
query isDiscovering {
  isDiscovering
}
query

mdnsState

Читает текущее состояние обнаружения mDNS и выбранные сведения о службах или пакетах.

graphql
query mdnsState {
  mdnsState { runtimeId revision running scanning }
}
query

nearbyDevices

Перечисляет известные сейчас соседние устройства, доступные для обнаружения или сопряжения.

graphql
query nearbyDevices {
  nearbyDevices { id name ips port remoteAccess signaturePublicKey deviceType version }
}
query

parsePairingQrCode

Декодирует действительный код сопряжения в сведения о подключении соседнего устройства.

graphql
query parsePairingQrCode($code: String!) {
  parsePairingQrCode(code: $code) { id name ips port remoteAccess signaturePublicKey deviceType version }
}