chrome.serial

Açıklama

Seri bağlantı noktasına bağlı bir cihazdan okuma ve yazma işlemleri yapmak için chrome.serial API'yi kullanın.

İzinler

serial

Türler

ConnectionInfo

Özellikler

  • bitrate

    sayı isteğe bağlı

    Şu sayfaya göz atın: ConnectionOptions.bitrate. Standart olmayan bir bit hızı kullanılıyorsa ya da 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 etkinliklerini tetiklemesinin engellenip engellenmediğini gösteren 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

    sayı isteğe bağlı

    Açılacak bağlantının istenen bit hızı. En geniş donanım yelpazesiyle uyumluluk için bu sayı; 110, 300, 1200, 2400, 4800, 9600, 14400, 19200, 38400, 57600, 115200 gibi yaygın olarak kullanılan bit hızlarından biriyle eşleşmelidir. Seri bağlantı noktasına bağlı cihazın, bağlantı noktası söz konusu bit hızını desteklese bile kesinlikle istenen bit hızını destekleyeceğinin garantisi yoktur. 9600 varsayılan olarak aktarılır.

  • bufferSize

    sayı isteğe bağlı

    Verileri 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 gösteren işaret. Varsayılan olarak yanlış değerine ayarlanır.

  • dataBits

    DataBits isteğe bağlı

    "eight" varsayılan olarak aktarılır.

  • 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 aktarılır.

  • kalıcı

    boole isteğe bağlı

    Uygulama askıya alındığında bağlantının açık bırakılmasının gerekip gerekmediğini gösteren işaret (Uygulama Yaşam Döngüsü Yönetimi başlıklı makaleye göz atın). Varsayılan değer "false" (yanlış) değeridir. Uygulama yüklendiğinde, daha önce kalıcı=true ile açılan tüm seri bağlantılar getConnections ile getirilebilir.

  • receiveTimeout

    sayı isteğe bağlı

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

  • sendTimeout

    sayı isteğe bağlı

    Geri çağırmayı "zaman aşımı" ile çağırmadan önce send işleminin tamamlanması için beklenecek maksimum süre (milisaniye cinsinden) hatası. 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 aktarılır.

DataBits

Enum

"yedi"

"sekiz"

DeviceControlSignals

Özellikler

  • ct'ler

    boolean

    CTS (Clear To Send).

  • dcd

    boolean

    DCD (Veri Operatörü Algılama) veya RLSD (Hat Sinyali Alma/ Algılama).

  • dsr

    boolean

    DSR (Veri Kümesi Hazır).

  • Rı

    boolean

    RI (Halka Göstergesi).

DeviceInfo

Özellikler

  • görünen ad

    dize isteğe bağlı

    Ana cihaz sürücüsü tarafından sorgulanabiliyorsa temel cihaz için kullanıcılar tarafından okunabilen bir görünen ad.

  • yol

    dize

    Cihazın sistem yolu. Bu cihaza bağlanmak için bu parametre, chrome.serial.connect adlı cihaza path bağımsız değişkeni olarak iletilmelidir.

  • productId

    sayı isteğe bağlı

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

  • vendorId

    sayı isteğe bağlı

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

HostControlSignals

Özellikler

  • dtr

    boole isteğe bağlı

    DTR (Veri Terminali Hazır).

  • rt'ler

    boole isteğe bağlı

    RTS (Gönderme İsteği).

ParityBit

Enum

"hayır"

"odd"

"eşit"

ReceiveError

Enum

"disconnected"
Bağlantı kesildi.

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

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

"break"
Cihaz bir kesme koşulu algıladı.

"frame_error"
Cihaz bir çerçeveleme hatası algıladı.

"overrun"
Karakter arabelleği aşımı oluştu. Sonraki karakter kaybolur.

"buffer_overflow"
Giriş arabellek taşması 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. Bağlantı kurtarılamayabilir.

ReceiveErrorInfo

Özellikler

  • connectionId

    sayı

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

  • Neyin yanlış gittiğini gösteren bir hata kodu.

ReceiveInfo

Özellikler

  • connectionId

    sayı

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

  • veri

    DiziArabelleği

    Alınan veriler.

SendError

Enum

"disconnected"
Bağlantı kesildi.

"pending"
Bir gönderme işlemi zaten beklemede.

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

"system_error"
Sistem hatası oluştu. 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

"bir"

"iki"

Yöntemler

clearBreak()

Söz Chrome 45 ve sonraki sürümler 
chrome.serial.clearBreak(
  connectionId: number,
  callback?: function,
)

Belirli bir bağlantıda karakter iletimini eski haline getirin ve iletim 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 'nı inceleyin.

    Vaatler yalnızca Manifest V3 ve sonraki sürümler için desteklenir. Diğer platformların geri çağırma yapması gerekir.

connect()

Söz 'nı inceleyin.
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 'nı inceleyin.

    Vaatler yalnızca Manifest V3 ve sonraki sürümler için desteklenir. Diğer platformların geri çağırma yapması gerekir.

disconnect()

Söz 'nı inceleyin.
chrome.serial.disconnect(
  connectionId: number,
  callback?: function,
)

Seri bağlantı noktasıyla olan bağlantıyı 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 'nı inceleyin.

    Vaatler yalnızca Manifest V3 ve sonraki sürümler için desteklenir. Diğer platformların geri çağırma yapması gerekir.

flush()

Söz 'nı inceleyin.
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 'nı inceleyin.

    Vaatler yalnızca Manifest V3 ve sonraki sürümler için desteklenir. Diğer platformların geri çağırma yapması gerekir.

getConnections()

Söz 'nı inceleyin.
chrome.serial.getConnections(
  callback?: function,
)

Uygulamanın sahip olduğu, o 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 'nı inceleyin.

    Vaatler yalnızca Manifest V3 ve sonraki sürümler için desteklenir. Diğer platformların geri çağırma yapması gerekir.

getControlSignals()

Söz 'nı inceleyin.
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

  • Promise<DeviceControlSignals>

    Chrome 117 ve sonraki sürümler 'nı inceleyin.

    Vaatler yalnızca Manifest V3 ve sonraki sürümler için desteklenir. Diğer platformların geri çağırma yapması gerekir.

getDevices()

Söz 'nı inceleyin.
chrome.serial.getDevices(
  callback?: function,
)

Sistemdeki kullanılabilir seri cihazlarla ilgili bilgileri döndürür. Bu yöntem her çağrıldığında liste 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 'nı inceleyin.

    Vaatler yalnızca Manifest V3 ve sonraki sürümler için desteklenir. Diğer platformların geri çağırma yapması gerekir.

getInfo()

Söz 'nı inceleyin.
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 'nı inceleyin.

    Vaatler yalnızca Manifest V3 ve sonraki sürümler için desteklenir. Diğer platformların geri çağırma yapması gerekir.

send()

Söz 'nı inceleyin.
chrome.serial.send(
  connectionId: number,
  data: ArrayBuffer,
  callback?: function,
)

Verilen bağlantıya veri yazar.

Parametreler

  • connectionId

    sayı

    Bağlantının kimliği.

  • veri

    DiziArabelleği

    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 'nı inceleyin.

    Vaatler yalnızca Manifest V3 ve sonraki sürümler için desteklenir. Diğer platformların geri çağırma yapması gerekir.

setBreak()

Söz Chrome 45 ve sonraki sürümler 
chrome.serial.setBreak(
  connectionId: number,
  callback?: function,
)

Belirli bir bağlantıda karakter iletimini askıya alır ve clearBreak çağrılana kadar iletim hattını ara durumuna geçirir.

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 'nı inceleyin.

    Vaatler yalnızca Manifest V3 ve sonraki sürümler için desteklenir. Diğer platformların geri çağırma yapması gerekir.

setControlSignals()

Söz 'nı inceleyin.
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 grubu değişir.

  • 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 'nı inceleyin.

    Vaatler yalnızca Manifest V3 ve sonraki sürümler için desteklenir. Diğer platformların geri çağırma yapması gerekir.

setPaused()

Söz 'nı inceleyin.
chrome.serial.setPaused(
  connectionId: number,
  paused: boolean,
  callback?: function,
)

Açık bir bağlantıyı duraklatır veya devam ettirir.

Parametreler

  • connectionId

    sayı

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

  • duraklatıldı

    boolean

    Duraklatmayı veya duraklatmayı kaldırmayı gösteren işaret.

  • geri çağırma

    işlev isteğe bağlı

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

    () => void

İadeler

  • Taahhüt<void>

    Chrome 117 ve sonraki sürümler 'nı inceleyin.

    Vaatler yalnızca Manifest V3 ve sonraki sürümler için desteklenir. Diğer platformların geri çağırma yapması gerekir.

update()

Söz 'nı inceleyin.
chrome.serial.update(
  connectionId: number,
  options: ConnectionOptions,
  callback?: function,
)

Açık bir seri bağlantı noktası bağlantısında 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&lt;boolean&gt;

    Chrome 117 ve sonraki sürümler 'nı inceleyin.

    Vaatler yalnızca Manifest V3 ve sonraki sürümler için desteklenir. Diğer platformların geri çağırma yapması gerekir.

Etkinlikler

onReceive

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

Bağlantıdan veri okunduğunda etkinlik ortaya çıktı.

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 bir hata oluştuğunda etkinlik oluştu. Bu etkinlik oluşturulduktan sonra bağlantı paused olarak ayarlanabilir. "timeout" hatası, bağlantıyı duraklatmaz.

Parametreler