chrome.serial

Açıklama

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

İzinler

serial

Kullanılabilirlik

Yalnızca ChromeOS

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 ya da 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 bir hata oluştuysa bu alan atlanabilir.

  • dataBits

    DataBits isteğe bağlı

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

  • duraklatıldı

    boole

    Bağlantının onReceive etkinliklerini tetiklemesinin engellenip engellenmediğini gösteren işaret.

  • kalıcı

    boole

    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 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 yelpazesiyle uyumluluk için bu sayı, yaygın olarak kullanılan bit hızlarından biriyle eşleşmelidir (ör. 110, 300, 1200, 2400, 4800, 9600, 14400, 19200, 38400, 57600, 115200). Elbette, bağlantı noktasının kendisi bu bit hızını desteklese bile seri bağlantı noktasına bağlı cihazın istenen bit hızını destekleyeceğinin garantisi yoktur. 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 gösteren işaret. Varsayılan olarak "false" (yanlış) değerine ayarlıdır.

  • dataBits

    DataBits isteğe bağlı

    "eight" varsayılan olarak iletilir.

  • ad

    string isteğe bağlı

    Bağlantıyla ilişkilendirilecek, uygulama tarafından tanımlanan 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ı gösteren işaret (Uygulama Yaşam Döngüsünü Yönetme bölümüne bakın). Varsayılan değer "false"dur. Uygulama yüklendiğinde, daha önce persistent=true ile açılmış tüm seri bağlantılar getConnections ile getirilebilir.

  • receiveTimeout

    number isteğe bağlı

    "Zaman aşımı" hatasıyla bir onReceiveError etkinliği oluşturmadan önce yeni veriler için beklenecek maksimum süre (milisaniye cinsinden). Sıfır olarak ayarlanırsa bağlantı için zaman aşımı hataları alınmaz. 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 beklenecek maksimum süre (milisaniye cinsinden). Sıfır olarak ayarlanı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 iletilir.

DataBits

Enum

"seven"

"sekiz"

DeviceControlSignals

Özellikler

  • cts

    boole

    CTS (Göndermeye Hazır).

  • dcd

    boole

    DCD (Veri Taşıyıcı Algılama) veya RLSD (Alma Hattı Sinyali/Algılama).

  • dsr

    boole

    DSR (Veri Kümesi Hazır).

  • ri

    boole

    RI (Zil Göstergesi).

DeviceInfo

Özellikler

  • görünen ad

    string isteğe bağlı

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

  • yol

    dize

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

  • productId

    number isteğe bağlı

    Temel cihaz için belirlenebiliyorsa bir 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 (Veri Terminali Hazır).

  • rts

    boole isteğe bağlı

    RTS (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 olasılıkla kesilmiştir.

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

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

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

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

"parity_error"
Cihaz bir 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ı.

  • Sorunun ne olduğunu gösteren bir hata kodu.

ReceiveInfo

Özellikler

  • connectionId

    sayı

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

  • veri

    ArrayBuffer

    Alınan veriler.

SendError

Enum

"disconnected"
Bağlantı kesildi.

"pending"
Zaten beklemede olan bir gönderme işlemi var.

"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"

"iki"

Yöntemler

clearBreak()

Promise Chrome 45+ 
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

    function isteğe bağlı

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

    (result: boolean) => void

    • sonuç

      boole

İadeler

  • Promise<boolean>

    Chrome 117 ve sonraki sürümler

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

connect()

Taahhüt 
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

    function 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

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

disconnect()

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

Seri bağlantı noktasıyla bağlantıyı keser.

Parametreler

  • connectionId

    sayı

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

  • callback

    function isteğe bağlı

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

    (result: boolean) => void

    • sonuç

      boole

İadeler

  • Promise<boolean>

    Chrome 117 ve sonraki sürümler

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

flush()

Taahhüt 
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

    function isteğe bağlı

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

    (result: boolean) => void

    • sonuç

      boole

İadeler

  • Promise<boolean>

    Chrome 117 ve sonraki sürümler

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

getConnections()

Taahhüt 
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

    function 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

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

getControlSignals()

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

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

Parametreler

  • connectionId

    sayı

    Bağlantının kimliği.

  • callback

    function isteğe bağlı

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

    (signals: DeviceControlSignals) => void

İadeler

  • Chrome 117 ve sonraki sürümler

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

getDevices()

Taahhüt 
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

    function 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

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

getInfo()

Taahhüt 
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

    function 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

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

send()

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

Verileri belirtilen bağlantıya yazar.

Parametreler

  • connectionId

    sayı

    Bağlantının kimliği.

  • veri

    ArrayBuffer

    Gönderilecek veriler.

  • callback

    function 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

    Promise'ler 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+ 
chrome.serial.setBreak(
  connectionId: number,
  callback?: function,
): Promise<boolean>

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

Parametreler

  • connectionId

    sayı

    Bağlantının kimliği.

  • callback

    function isteğe bağlı

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

    (result: boolean) => void

    • sonuç

      boole

İadeler

  • Promise<boolean>

    Chrome 117 ve sonraki sürümler

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

setControlSignals()

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

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

Parametreler

  • connectionId

    sayı

    Bağlantının kimliği.

  • sinyaller

    HostControlSignals

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

  • callback

    function isteğe bağlı

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

    (result: boolean) => void

    • sonuç

      boole

İadeler

  • Promise<boolean>

    Chrome 117 ve sonraki sürümler

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

setPaused()

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

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

Parametreler

  • connectionId

    sayı

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

  • duraklatıldı

    boole

    Duraklatma veya devam ettirme durumunu gösteren işaret.

  • callback

    function isteğe bağlı

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

    () => void

İadeler

  • Promise<void>

    Chrome 117 ve sonraki sürümler

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

update()

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

Açık bir seri bağlantı noktası 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.

  • callback

    function isteğe bağlı

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

    (result: boolean) => void

    • sonuç

      boole

İadeler

  • Promise<boolean>

    Chrome 117 ve sonraki sürümler

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

Parametreler