chrome.serial

Açıklama

Seri bağlantı noktasına bağlı bir cihazdan veri okumak ve cihaza veri yazmak için chrome.serial API'yi kullanın.

İzinler

serial

Türler

ConnectionInfo

Özellikler

  • bitrate

    number isteğe bağlı

    Şu sayfaya göz atın: ConnectionOptions.bitrate. Standart olmayan bir bit hızı kullanılıyorsa veya temel cihaz sorgulanırken bir hata oluştuysa bu alan atlanabilir veya yanlış olabilir.

  • bufferSize

    sayı

    Göz atın: ConnectionOptions.bufferSize

  • connectionId

    sayı

    Seri bağlantı noktası bağlantısının kimliği.

  • ctsFlowControl

    boole isteğe bağlı

    Şu sayfaya göz atın: ConnectionOptions.ctsFlowControl. Temel cihaz sorgulanırken hata oluştuysa bu alan atlanabilir.

  • dataBits

    DataBits isteğe bağlı

    Şu sayfaya göz atın: ConnectionOptions.dataBits. Temel cihaz sorgulanırken hata oluştuysa bu alan atlanabilir.

  • ad

    dize

    Göz atın: ConnectionOptions.name

  • parityBit

    ParityBit isteğe bağlı

    Şu sayfaya göz atın: ConnectionOptions.parityBit. Temel cihaz sorgulanırken hata oluştuysa bu alan atlanabilir.

  • duraklatıldı

    boolean

    Bağlantının onReceive etkinliklerinin tetiklenmesini engelleyip engellemediğini belirten işaret.

  • kalıcı

    boolean

    Göz atın: ConnectionOptions.persistent

  • receiveTimeout

    sayı

    Göz atın: ConnectionOptions.receiveTimeout

  • sendTimeout

    sayı

    Göz atın: ConnectionOptions.sendTimeout

  • stopBits

    StopBits isteğe bağlı

    Şu sayfaya göz atın: ConnectionOptions.stopBits. Temel cihaz sorgulanırken hata oluştuysa bu alan atlanabilir.

ConnectionOptions

Özellikler

  • bitrate

    number isteğe bağlı

    Açılacak bağlantının istenen bit hızı. En geniş donanım yelpazesiyle uyumlu olması için bu sayı, yaygın olarak kullanılan bit hızlarından biriyle (ör. 110, 300, 1.200, 2.400, 4.800, 9.600, 14.400, 19.200, 38.400, 57.600, 115.200) eşleşmelidir. Bağlantı noktası bu bit hızını desteklese bile seri bağlantı noktasına bağlı cihazın istenen bit hızını destekleyeceği garanti edilmez. 9600 varsayılan olarak iletilir.

  • bufferSize

    number isteğe bağlı

    Veri almak için kullanılan arabelleğin boyutu. Varsayılan değer 4096'dır.

  • ctsFlowControl

    boole isteğe bağlı

    RTS/CTS donanım akış kontrolünün etkinleştirilip etkinleştirilmeyeceğini belirten işaret. Varsayılan değer yanlıştır.

  • dataBits

    DataBits isteğe bağlı

    "eight" varsayılan olarak iletilir.

  • ad

    dize isteğe bağlı

    Bağlantıyla ilişkilendirilecek, uygulama tarafından tanımlanan bir dize.

  • parityBit

    ParityBit isteğe bağlı

    "no" varsayılan olarak iletilir.

  • kalıcı

    boole isteğe bağlı

    Uygulama askıya alındığında bağlantının açık bırakılıp bırakılmayacağını belirten işaret (Uygulama Yaşam Döngüsünü Yönetme bölümüne bakın). Varsayılan değer "false" (yanlış) değeridir. Uygulama yüklendiğinde, daha önce persistent=true ile açılan tüm seri bağlantılar getConnections ile getirilebilir.

  • receiveTimeout

    number isteğe bağlı

    "Zaman aşımı" hatası içeren bir onReceiveError etkinliği oluşturmadan önce yeni veriler için beklenen maksimum süre (milisaniye cinsinden). Sıfır ise bağlantı için alma zaman aşımı hataları oluşmaz. Varsayılan olarak 0 değerine ayarlanır.

  • sendTimeout

    number isteğe bağlı

    "zaman aşımı" hatasıyla geri çağırma işlevini çağırmadan önce send işleminin tamamlanması için beklenen maksimum süre (milisaniye cinsinden). Sıfır ise gönderme zaman aşımı hataları tetiklenmez. Varsayılan olarak 0 değerine ayarlanır.

  • stopBits

    StopBits isteğe bağlı

    "one" varsayılan olarak iletilir.

DataBits

Enum

"seven"

"eight"

DeviceControlSignals

Özellikler

  • cts

    boolean

    CTS (Gönderme İzni).

  • dcd

    boolean

    DCD (Veri Aktarıcı Algılama) veya RLSD (Alıcı Hattı Sinyal/ Algılama).

  • dsr

    boolean

    DSR (Veri Kümesi Hazır).

  • ri

    boolean

    RI (Ring Indicator).

DeviceInfo

Özellikler

  • görünen ad

    dize isteğe bağlı

    Ana makine sürücüsünden sorgulanabilirse temel cihazın okunabilir görünen adı.

  • yol

    dize

    Cihazın sistem yolu. Bu cihaza bağlanmak için path bağımsız değişkeni chrome.serial.connect bağımsız değişkenine aktarılmalıdır.

  • productId

    number isteğe bağlı

    Temel cihaz için belirlenebiliyorsa USB ürün kimliği.

  • vendorId

    number isteğe bağlı

    Temel cihaz için belirlenebiliyorsa PCI veya USB tedarikçi kimliği.

HostControlSignals

Özellikler

  • dtr

    boole isteğe bağlı

    DTR (Data Terminal Ready).

  • rts

    boole isteğe bağlı

    RTS (Gönderme İsteği).

ParityBit

Enum

"no"

"odd"

"even"

ReceiveError

Enum

"disconnected"
Bağlantının bağlantısı kesildi.

"timeout"
receiveTimeout milisaniye boyunca veri alınmadı.

"device_lost"
Cihazın ana makineyle bağlantısı büyük olasılıkla kesildi.

"break"
Cihaz, ara verme koşulu algıladı.

"frame_error"
Cihaz, kadraj hatası algıladı.

"overrun"
Karakter arabelleğinin taşması oluştu. Sonraki karakter kaybolur.

"buffer_overflow"
Giriş arabelleğinde taşma oluştu. Giriş arabelleğinde yer yok veya dosya sonu (EOF) karakterinden sonra bir karakter alındı.

"parity_error"
Cihaz bir parite hatası algıladı.

"system_error"
Sistem hatası oluştu ve bağlantı kurtarılamayabilir.

ReceiveErrorInfo

Özellikler

  • connectionId

    sayı

    Bağlantı tanımlayıcısı.

  • Sorunun ne olduğunu belirten bir hata kodu.

ReceiveInfo

Özellikler

  • connectionId

    sayı

    Bağlantı tanımlayıcısı.

  • veri

    ArrayBuffer

    Alınan veriler.

SendError

Enum

"disconnected"
Bağlantının bağlantısı kesildi.

"beklemede"
Gönderim işlemi beklemede.

"timeout"
Gönderme zaman aşımına uğradı.

"system_error"
Sistem hatası oluştu ve bağlantı kurtarılamayabilir.

SendInfo

Özellikler

  • bytesSent

    sayı

    Gönderilen bayt sayısı.

  • hata

    SendError isteğe bağlı

    Hata oluştuysa hata kodu.

StopBits

Enum

"one"

"two"

Yöntemler

clearBreak()

Promise Chrome 45 ve üzeri sürümler 
chrome.serial.clearBreak(
  connectionId: number,
  callback?: function,
)

Belirli bir bağlantıda karakter aktarımını geri yükleyin ve aktarım hattını kesintisiz duruma getirin.

Parametreler

  • connectionId

    sayı

    Bağlantının kimliği.

  • geri çağırma

    işlev isteğe bağlı

    callback parametresi şu şekilde görünür: 

    (result: boolean) => void

    • sonuç

      boolean

İadeler

  • Promise<boolean>

    Chrome 117 ve sonraki sürümler

    Sözler yalnızca Manifest V3 ve sonraki sürümlerde desteklenir. Diğer platformların geri çağırma işlevlerini kullanması gerekir.

connect()

Promise 
chrome.serial.connect(
  path: string,
  options?: ConnectionOptions,
  callback?: function,
)

Belirli bir seri bağlantı noktasına bağlanır.

Parametreler

  • yol

    dize

    Açılacak seri bağlantı noktasının sistem yolu.

  • seçenekler

    ConnectionOptions isteğe bağlı

    Bağlantı noktası yapılandırma seçenekleri.

  • geri çağırma

    işlev isteğe bağlı

    callback parametresi şu şekilde görünür: 

    (connectionInfo: ConnectionInfo) => void

İadeler

  • Promise<ConnectionInfo>

    Chrome 117 ve sonraki sürümler

    Sözler yalnızca Manifest V3 ve sonraki sürümlerde desteklenir. Diğer platformların geri çağırma işlevlerini kullanması gerekir.

disconnect()

Promise 
chrome.serial.disconnect(
  connectionId: number,
  callback?: function,
)

Seri bağlantı noktasının bağlantısını keser.

Parametreler

  • connectionId

    sayı

    Açılan bağlantının kimliği.

  • geri çağırma

    işlev isteğe bağlı

    callback parametresi şu şekilde görünür: 

    (result: boolean) => void

    • sonuç

      boolean

İadeler

  • Promise<boolean>

    Chrome 117 ve sonraki sürümler

    Sözler yalnızca Manifest V3 ve sonraki sürümlerde desteklenir. Diğer platformların geri çağırma işlevlerini kullanması gerekir.

flush()

Promise 
chrome.serial.flush(
  connectionId: number,
  callback?: function,
)

Belirtilen bağlantının giriş ve çıkış arabelleklerindeki tüm baytları temizler.

Parametreler

  • connectionId

    sayı

  • geri çağırma

    işlev isteğe bağlı

    callback parametresi şu şekilde görünür: 

    (result: boolean) => void

    • sonuç

      boolean

İadeler

  • Promise<boolean>

    Chrome 117 ve sonraki sürümler

    Sözler yalnızca Manifest V3 ve sonraki sürümlerde desteklenir. Diğer platformların geri çağırma işlevlerini kullanması gerekir.

getConnections()

Promise 
chrome.serial.getConnections(
  callback?: function,
)

Uygulamaya ait şu anda açık olan seri bağlantı noktası bağlantılarının listesini alır.

Parametreler

  • geri çağırma

    işlev isteğe bağlı

    callback parametresi şu şekilde görünür: 

    (connectionInfos: ConnectionInfo[]) => void

İadeler

  • Promise<ConnectionInfo[]>

    Chrome 117 ve sonraki sürümler

    Sözler yalnızca Manifest V3 ve sonraki sürümlerde desteklenir. Diğer platformların geri çağırma işlevlerini kullanması gerekir.

getControlSignals()

Promise 
chrome.serial.getControlSignals(
  connectionId: number,
  callback?: function,
)

Belirli bir bağlantıdaki kontrol sinyallerinin durumunu alır.

Parametreler

  • connectionId

    sayı

    Bağlantının kimliği.

  • geri çağırma

    işlev isteğe bağlı

    callback parametresi şu şekilde görünür: 

    (signals: DeviceControlSignals) => void

İadeler

  • Chrome 117 ve sonraki sürümler

    Sözler yalnızca Manifest V3 ve sonraki sürümlerde desteklenir. Diğer platformların geri çağırma işlevlerini kullanması gerekir.

getDevices()

Promise 
chrome.serial.getDevices(
  callback?: function,
)

Sistemde bulunan seri cihazlar hakkında bilgi döndürür. Liste, bu yöntem her çağrıldığında yeniden oluşturulur.

Parametreler

  • geri çağırma

    işlev isteğe bağlı

    callback parametresi şu şekilde görünür: 

    (ports: DeviceInfo[]) => void

İadeler

  • Promise<DeviceInfo[]>

    Chrome 117 ve sonraki sürümler

    Sözler yalnızca Manifest V3 ve sonraki sürümlerde desteklenir. Diğer platformların geri çağırma işlevlerini kullanması gerekir.

getInfo()

Promise 
chrome.serial.getInfo(
  connectionId: number,
  callback?: function,
)

Belirli bir bağlantının durumunu alır.

Parametreler

  • connectionId

    sayı

    Açılan bağlantının kimliği.

  • geri çağırma

    işlev isteğe bağlı

    callback parametresi şu şekilde görünür: 

    (connectionInfo: ConnectionInfo) => void

İadeler

  • Promise<ConnectionInfo>

    Chrome 117 ve sonraki sürümler

    Sözler yalnızca Manifest V3 ve sonraki sürümlerde desteklenir. Diğer platformların geri çağırma işlevlerini kullanması gerekir.

send()

Promise 
chrome.serial.send(
  connectionId: number,
  data: ArrayBuffer,
  callback?: function,
)

Belirtilen bağlantıya veri yazar.

Parametreler

  • connectionId

    sayı

    Bağlantının kimliği.

  • veri

    ArrayBuffer

    Gönderilecek veriler.

  • geri çağırma

    işlev isteğe bağlı

    callback parametresi şu şekilde görünür: 

    (sendInfo: SendInfo) => void

İadeler

  • Promise<SendInfo>

    Chrome 117 ve sonraki sürümler

    Sözler yalnızca Manifest V3 ve sonraki sürümlerde desteklenir. Diğer platformların geri çağırma işlevlerini kullanması gerekir.

setBreak()

Promise Chrome 45 ve üzeri sürümler 
chrome.serial.setBreak(
  connectionId: number,
  callback?: function,
)

Belirli bir bağlantıdaki karakter aktarımını askıya alır ve clearBreak çağrılana kadar aktarım hattını ara verme durumuna getirir.

Parametreler

  • connectionId

    sayı

    Bağlantının kimliği.

  • geri çağırma

    işlev isteğe bağlı

    callback parametresi şu şekilde görünür: 

    (result: boolean) => void

    • sonuç

      boolean

İadeler

  • Promise<boolean>

    Chrome 117 ve sonraki sürümler

    Sözler yalnızca Manifest V3 ve sonraki sürümlerde desteklenir. Diğer platformların geri çağırma işlevlerini kullanması gerekir.

setControlSignals()

Promise 
chrome.serial.setControlSignals(
  connectionId: number,
  signals: HostControlSignals,
  callback?: function,
)

Belirli bir bağlantıdaki kontrol sinyallerinin durumunu ayarlar.

Parametreler

  • connectionId

    sayı

    Bağlantının kimliği.

  • Cihaza gönderilecek sinyal değişiklikleri grubu.

  • geri çağırma

    işlev isteğe bağlı

    callback parametresi şu şekilde görünür: 

    (result: boolean) => void

    • sonuç

      boolean

İadeler

  • Promise<boolean>

    Chrome 117 ve sonraki sürümler

    Sözler yalnızca Manifest V3 ve sonraki sürümlerde desteklenir. Diğer platformların geri çağırma işlevlerini kullanması gerekir.

setPaused()

Promise 
chrome.serial.setPaused(
  connectionId: number,
  paused: boolean,
  callback?: function,
)

Açık bir bağlantıyı duraklatır veya duraklatmayı kaldırır.

Parametreler

  • connectionId

    sayı

    Açılan bağlantının kimliği.

  • duraklatıldı

    boolean

    Duraklatmanın veya duraklatmanın kaldırılmasının belirtildiği işaret.

  • geri çağırma

    işlev isteğe bağlı

    callback parametresi şu şekilde görünür: 

    () => void

İadeler

  • Promise<void>

    Chrome 117 ve sonraki sürümler

    Sözler yalnızca Manifest V3 ve sonraki sürümlerde desteklenir. Diğer platformların geri çağırma işlevlerini kullanması gerekir.

update()

Promise 
chrome.serial.update(
  connectionId: number,
  options: ConnectionOptions,
  callback?: function,
)

Açık bir seri bağlantı bağlantısındaki seçenek ayarlarını güncelleyin.

Parametreler

  • connectionId

    sayı

    Açılan bağlantının kimliği.

  • seçenekler

    ConnectionOptions

    Bağlantı noktası yapılandırma seçenekleri.

  • geri çağırma

    işlev isteğe bağlı

    callback parametresi şu şekilde görünür: 

    (result: boolean) => void

    • sonuç

      boolean

İadeler

  • Promise<boolean>

    Chrome 117 ve sonraki sürümler

    Sözler yalnızca Manifest V3 ve sonraki sürümlerde desteklenir. Diğer platformların geri çağırma işlevlerini kullanması gerekir.

Etkinlikler

onReceive

chrome.serial.onReceive.addListener(
  callback: function,
)

Bağlantıdan veri okunduğunda oluşturulan etkinlik.

Parametreler

  • geri çağırma

    işlev

    callback parametresi şu şekilde görünür: 

    (info: ReceiveInfo) => void

onReceiveError

chrome.serial.onReceiveError.addListener(
  callback: function,
)

Çalışma zamanı seri bağlantı noktasında veri beklerken hata oluştuğunda etkinlik oluşturulur. Bu etkinlik oluşturulduktan sonra bağlantı paused olarak ayarlanabilir. "timeout" hatası, bağlantıyı duraklatmaz.

Parametreler