blefyi

TypeScript API client for BLEFYI -- the comprehensive Bluetooth Low Energy reference covering BLE chips (nRF52, ESP32, CC2640), GATT profiles, beacon protocols (iBeacon, Eddystone, AltBeacon), BLE versions from 4.0 to 5.4, and manufacturers. Zero dependencies, uses native fetch.

Explore BLE at blefyi.com -- Chips | Profiles | Glossary | API Docs

Install

npm install blefyi

Works in Node.js, Deno, Bun, and browsers (ESM).

Quick Start

import { BLEFYI } from "blefyi";

const api = new BLEFYI();

// Search BLE chips, profiles, beacons
const results = await api.search("nrf52840");

// Get BLE chip detail
const nrf52 = await api.chip("nrf52840");
console.log(nrf52.manufacturer);  // "Nordic Semiconductor"
console.log(nrf52.ble_version);   // "5.0"

// Get beacon protocol detail
const ibeacon = await api.beacon("ibeacon");

// Compare two BLE chips
const comparison = await api.compare("nrf52840", "esp32-c3");

API Methods

| Method | Description | |--------|-------------| | search(query) | Search chips, profiles, beacons, glossary | | glossaryTerm(slug) | Get glossary term definition | | chip(slug) | BLE chip detail | | profile(slug) | GATT profile detail | | version(slug) | BLE version detail | | beacon(slug) | Beacon protocol detail | | usecase(slug) | Use case detail | | manufacturer(slug) | Manufacturer detail | | compare(slugA, slugB) | Compare two BLE chips | | random() | Random BLE chip | | openapi() | OpenAPI 3.1.0 specification |

TypeScript Types

import type {
  SearchResult, ChipDetail, ProfileDetail, VersionDetail,
  BeaconDetail, UsecaseDetail, ManufacturerDetail, GlossaryTerm, CompareResult,
} from "blefyi";

Also Available

| Language | Package | |----------|---------| | Python | blefyi on PyPI | | TypeScript | This package |

Code FYI Family

Part of the FYIPedia open-source developer tools ecosystem -- automatic identification and data capture technologies.

| Package | npm | Description | |---------|-----|-------------| | barcodefyi | npm | Barcode symbologies, standards -- barcodefyi.com | | qrcodefyi | npm | QR code types, versions, encoding -- qrcodefyi.com | | nfcfyi | npm | NFC chips, NDEF, standards -- nfcfyi.com | | blefyi | npm | BLE profiles, beacons, chips -- blefyi.com | | rfidfyi | npm | RFID tags, readers, frequencies -- rfidfyi.com | | smartcardfyi | npm | Smart cards, EMV, platforms -- smartcardfyi.com |

License

MIT