chrome.serial

Açıklama

Seri bağlantı noktasına bağlı bir cihazdan okuma ve cihaza yazma işlemleri için chrome.serial API'sini 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 cihaza sorgu gönderilirken 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

    boolean isteğe bağlı

    Şu sayfaya göz atın: ConnectionOptions.ctsFlowControl. Temel cihaza sorgu gönderilirken bir hata oluştuysa bu alan atlanabilir.

  • dataBits

    DataBits isteğe bağlı

    Şu sayfaya göz atın: ConnectionOptions.dataBits. Temel cihaza sorgu gönderilirken bir 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 cihaza sorgu gönderilirken bir hata oluştuysa bu alan atlanabilir.

  • duraklatıldı

    boolean

    Bağlantının onReceive etkinliklerinin tetiklenmesini 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 cihaza sorgu gönderilirken bir 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 aralığıyla uyumluluk için bu sayı, yaygın olarak kullanılan bit hızlarından biriyle (ör. 110, 300, 1200, 2400, 4800, 9600, 14400, 19200, 38400, 57600, 115200) eşleşmelidir. Elbette, bağlantı noktasının kendisi istenen bit hızını desteklese bile seri bağlantı noktasına bağlı cihazın bu bit hızını destekleyeceği garanti edilmez. 9600 varsayılan olarak iletilecektir.

  • bufferSize

    number isteğe bağlı

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

  • ctsFlowControl

    boolean isteğe bağlı

    RTS/CTS donanım akışı kontrolünün etkinleştirilip etkinleştirilmeyeceğini gösteren işaret. Varsayılan olarak false değerine ayarlanır.

  • dataBits

    DataBits isteğe bağlı

    "eight" varsayılan olarak iletilecektir.

  • ad

    dize isteğe bağlı

    Bağlantıyla ilişkilendirilecek uygulama tanımlı bir dize.

  • parityBit

    ParityBit isteğe bağlı

    "no" varsayılan olarak iletilecektir.

  • kalıcı

    boolean isteğe bağlı

    Uygulama askıya alındığında bağlantının açık bırakılıp bırakılmaması gerektiğini belirten işaret (bkz. Uygulama Yaşam Döngüsünü Yönetme). Varsayılan değer "false" değeridir. Uygulama yüklendiğinde, daha önce persistent=true ile açılmış olan 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 beklenecek maksimum süre (milisaniye cinsinden). Sıfırsa bağlantı için alma zaman aşımı hataları oluşturulmaz. Varsayılan olarak 0 değerine ayarlanır.

  • sendTimeout

    number isteğe bağlı

    Geri çağırma işlevi "zaman aşımı" hatasıyla çağrılmadan önce send işleminin tamamlanması için beklenecek maksimum süre (milisaniye cinsinden). Sıfırsa 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 iletilecektir.

DataBits

Enum

"seven"

"eight"

DeviceControlSignals

Özellikler

  • cts

    boolean

    CTS (Clear To Send)

  • dcd

    boolean

    DCD (Data Carrier Detect) veya RLSD (Receive Line Signal/ Detect).

  • dsr

    boolean

    DSR (Data Set Ready)

  • ri

    boolean

    RI (Zil Göstergesi).

DeviceInfo

Özellikler

  • görünen ad

    dize isteğe bağlı

    Ana makine sürücüsünden sorgulanabiliyorsa temel alınan cihaz için kullanıcılar tarafından okunabilir bir görünen ad.

  • yol

    dize

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

  • 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 bir PCI veya USB tedarikçi kimliği.

HostControlSignals

Özellikler

  • dtr

    boolean isteğe bağlı

    DTR (Data Terminal Ready).

  • rts

    boolean isteğe bağlı

    RTS (Request To Send - Gönderme İsteği).

ParityBit

Enum

"no"

"odd"

"even"

ReceiveError

Enum

"disconnected"
Bağlantı kesildi.

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

"device_lost"
Cihazın ana makineyle bağlantısı büyük ihtimalle kesilmiştir.

"break"
Cihaz, bir mola koşulu algıladı.

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

"overrun"
Karakter arabellek taşması oluştu. Sonraki karakter kaybolur.

"buffer_overflow"
Giriş arabellek taşması oluştu. Giriş arabelleğinde yer yoktur veya dosya sonu (EOF) karakterinden sonra bir karakter alınmıştır.

"parity_error"
Cihaz, eşlik hatası algıladı.

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

  • aktarma

    ArrayBuffer

    Alınan veriler.

SendError

Enum

"disconnected"
Bağlantı kesildi.

"Beklemede"
Gönderme işlemi zaten beklemede.

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

"system_error"
Bir 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 sonraki sürümler 
chrome.serial.clearBreak(
  connectionId: number,
  callback?: function,
): Promise<boolean>

Belirli bir bağlantıda karakter iletimini geri yükler ve iletim hattını kesintisiz duruma getirir.

Parametreler

  • connectionId

    sayı

    Bağlantının kimliği.

  • callback

    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

    Promises yalnızca Manifest V3 ve sonraki sürümlerde desteklenir. Diğer platformlarda geri çağırmalar kullanılmalıdır.

connect()

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

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.

  • callback

    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

    Promises yalnızca Manifest V3 ve sonraki sürümlerde desteklenir. Diğer platformlarda geri çağırmalar kullanılmalıdır.

disconnect()

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

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

Parametreler

  • connectionId

    sayı

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

  • callback

    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

    Promises yalnızca Manifest V3 ve sonraki sürümlerde desteklenir. Diğer platformlarda geri çağırmalar kullanılmalıdır.

flush()

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

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

Parametreler

  • connectionId

    sayı

  • callback

    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

    Promises yalnızca Manifest V3 ve sonraki sürümlerde desteklenir. Diğer platformlarda geri çağırmalar kullanılmalıdır.

getConnections()

Promise 
chrome.serial.getConnections(
  callback?: function,
): Promise<ConnectionInfo[]>

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

Parametreler

  • callback

    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

    Promises yalnızca Manifest V3 ve sonraki sürümlerde desteklenir. Diğer platformlarda geri çağırmalar kullanılmalıdır.

getControlSignals()

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

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

Parametreler

İadeler

  • Chrome 117 ve sonraki sürümler

    Promises yalnızca Manifest V3 ve sonraki sürümlerde desteklenir. Diğer platformlarda geri çağırmalar kullanılmalıdır.

getDevices()

Promise 
chrome.serial.getDevices(
  callback?: function,
): Promise<DeviceInfo[]>

Sistemdeki kullanılabilir seri cihazlar hakkında bilgi döndürür. Bu yöntem her çağrıldığında liste yeniden oluşturulur.

Parametreler

  • callback

    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

    Promises yalnızca Manifest V3 ve sonraki sürümlerde desteklenir. Diğer platformlarda geri çağırmalar kullanılmalıdır.

getInfo()

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

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

Parametreler

  • connectionId

    sayı

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

  • callback

    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

    Promises yalnızca Manifest V3 ve sonraki sürümlerde desteklenir. Diğer platformlarda geri çağırmalar kullanılmalıdır.

send()

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

Belirtilen bağlantıya veri yazar.

Parametreler

  • connectionId

    sayı

    Bağlantının kimliği.

  • aktarma

    ArrayBuffer

    Gönderilecek veriler.

  • callback

    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

    Promises yalnızca Manifest V3 ve sonraki sürümlerde desteklenir. Diğer platformlarda geri çağırmalar kullanılmalıdır.

setBreak()

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

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

Parametreler

  • connectionId

    sayı

    Bağlantının kimliği.

  • callback

    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

    Promises yalnızca Manifest V3 ve sonraki sürümlerde desteklenir. Diğer platformlarda geri çağırmalar kullanılmalıdır.

setControlSignals()

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

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

Parametreler

  • connectionId

    sayı

    Bağlantının kimliği.

  • sinyaller

    HostControlSignals

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

  • callback

    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

    Promises yalnızca Manifest V3 ve sonraki sürümlerde desteklenir. Diğer platformlarda geri çağırmalar kullanılmalıdır.

setPaused()

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

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

    Duraklatılacağını veya devam ettirileceğini belirten işaret.

  • callback

    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

    Promises yalnızca Manifest V3 ve sonraki sürümlerde desteklenir. Diğer platformlarda geri çağırmalar kullanılmalıdır.

update()

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

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.

  • callback

    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

    Promises yalnızca Manifest V3 ve sonraki sürümlerde desteklenir. Diğer platformlarda geri çağırmalar kullanılmalıdır.

Etkinlikler

onReceive

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

Bağlantıdan veri okunduğunda tetiklenen etkinlik.

Parametreler

  • callback

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

Parametreler