mirror of https://github.com/periph/devices
devices: overhaul documentation
- Standardize package documentation into doc.go - Link back to the web site in a standardized way - Update datasheet links for leptonpull/1/head
Marc-Antoine Ruel
8 years ago
parent
f7ddfe8f13
commit
98e2118731
@ -0,0 +1,37 @@
|
||||
// Copyright 2016 The Periph Authors. All rights reserved.
|
||||
// Use of this source code is governed under the Apache License, Version 2.0
|
||||
// that can be found in the LICENSE file.
|
||||
|
||||
// Package bmxx80 controls a Bosch BMP180/BME280/BMP280 device over I²C, or SPI
|
||||
// for the BMx280.
|
||||
//
|
||||
// More details
|
||||
//
|
||||
// See https://periph.io/device/bmxx80/ for more details about the device.
|
||||
//
|
||||
// Datasheets
|
||||
//
|
||||
// The URLs tend to rot, visit https://www.bosch-sensortec.com if they become
|
||||
// invalid.
|
||||
//
|
||||
// BME280:
|
||||
// https://ae-bst.resource.bosch.com/media/_tech/media/datasheets/BST-BME280_DS001-12.pdf
|
||||
//
|
||||
// BMP280:
|
||||
// https://ae-bst.resource.bosch.com/media/_tech/media/datasheets/BST-BMP280-DS001-19.pdf
|
||||
//
|
||||
// BMP180:
|
||||
// https://ae-bst.resource.bosch.com/media/_tech/media/datasheets/BST-BMP180-DS000-12.pdf
|
||||
//
|
||||
// The font the official datasheet on page 15 is hard to read, a copy with
|
||||
// readable text can be found here:
|
||||
//
|
||||
// https://cdn-shop.adafruit.com/datasheets/BST-BMP180-DS000-09.pdf
|
||||
//
|
||||
// Notes on the BMP180 datasheet
|
||||
//
|
||||
// The results of the calculations in the algorithm on page 15 are partly
|
||||
// wrong. It looks like the original authors used non-integer calculations and
|
||||
// some nubers were rounded. Take the results of the calculations with a grain
|
||||
// of salt.
|
||||
package bmxx80
|
||||
@ -0,0 +1,26 @@
|
||||
// Copyright 2016 The Periph Authors. All rights reserved.
|
||||
// Use of this source code is governed under the Apache License, Version 2.0
|
||||
// that can be found in the LICENSE file.
|
||||
|
||||
// Package ds18b20 interfaces to Dallas Semi / Maxim DS18B20 and MAX31820
|
||||
// 1-wire temperature sensors.
|
||||
//
|
||||
// Note that both DS18B20 and MAX31820 use family code 0x28.
|
||||
//
|
||||
// Both powered sensors and parasitically powered sensors are supported
|
||||
// as long as the bus driver can provide sufficient power using an active
|
||||
// pull-up.
|
||||
//
|
||||
// The DS18B20 alarm functionality and reading/writing the 2 alarm bytes in
|
||||
// the EEPROM are not supported. The DS18S20 is also not supported.
|
||||
//
|
||||
// More details
|
||||
//
|
||||
// See https://periph.io/device/ds18b20/ for more details about the device.
|
||||
//
|
||||
// Datasheets
|
||||
//
|
||||
// https://datasheets.maximintegrated.com/en/ds/DS18B20-PAR.pdf
|
||||
//
|
||||
// http://datasheets.maximintegrated.com/en/ds/MAX31820.pdf
|
||||
package ds18b20
|
||||
@ -0,0 +1,17 @@
|
||||
// Copyright 2016 The Periph Authors. All rights reserved.
|
||||
// Use of this source code is governed under the Apache License, Version 2.0
|
||||
// that can be found in the LICENSE file.
|
||||
|
||||
// Package ds248x controls a Maxim DS2483 or DS2482-100 1-wire interface chip
|
||||
// over I²C.
|
||||
//
|
||||
// More details
|
||||
//
|
||||
// See https://periph.io/device/ds248x/ for more details about the device.
|
||||
//
|
||||
// Datasheets
|
||||
//
|
||||
// https://www.maximintegrated.com/en/products/digital/one-wire/DS2483.html
|
||||
//
|
||||
// https://www.maximintegrated.com/en/products/interface/controllers-expanders/DS2482-100.html
|
||||
package ds248x
|
||||
@ -0,0 +1,14 @@
|
||||
// Copyright 2017 The Periph Authors. All rights reserved.
|
||||
// Use of this source code is governed under the Apache License, Version 2.0
|
||||
// that can be found in the LICENSE file.
|
||||
|
||||
// Package cci declares the Camera Command Interface to interact with a FLIR
|
||||
// Lepton over I²C.
|
||||
//
|
||||
// This protocol controls and queries the camera but is not used to read the
|
||||
// images.
|
||||
//
|
||||
// Datasheet
|
||||
//
|
||||
// https://www.flir.com/globalassets/imported-assets/document/flir-lepton-software-interface-description-document.pdf
|
||||
package cci
|
||||
@ -0,0 +1,14 @@
|
||||
// Copyright 2017 The Periph Authors. All rights reserved.
|
||||
// Use of this source code is governed under the Apache License, Version 2.0
|
||||
// that can be found in the LICENSE file.
|
||||
|
||||
// Package lepton drives a FLIR Lepton Infra Red (IR) camera.
|
||||
//
|
||||
// More details
|
||||
//
|
||||
// See https://periph.io/device/lepton/ for more details about the device.
|
||||
//
|
||||
// Datasheet
|
||||
//
|
||||
// https://www.flir.com/globalassets/imported-assets/document/lepton-engineering-datasheet---with-radiometry.pdf
|
||||
package lepton
|
||||
@ -0,0 +1,35 @@
|
||||
// Copyright 2016 The Periph Authors. All rights reserved.
|
||||
// Use of this source code is governed under the Apache License, Version 2.0
|
||||
// that can be found in the LICENSE file.
|
||||
|
||||
// Package ssd1306 controls a 128x64 monochrome OLED display via a SSD1306
|
||||
// controller.
|
||||
//
|
||||
// The driver does differential updates: it only sends modified pixels for the
|
||||
// smallest rectangle, to economize bus bandwidth. This is especially important
|
||||
// when using I²C as the bus default speed (often 100kHz) is slow enough to
|
||||
// saturate the bus at less than 10 frames per second.
|
||||
//
|
||||
// The SSD1306 is a write-only device. It can be driven on either I²C or SPI
|
||||
// with 4 wires. Changing between protocol is likely done through resistor
|
||||
// soldering, for boards that support both.
|
||||
//
|
||||
// Some boards expose a RES / Reset pin. If present, it must be normally be
|
||||
// High. When set to Low (Ground), it enables the reset circuitry. It can be
|
||||
// used externally to this driver, if used, the driver must be reinstantiated.
|
||||
//
|
||||
// More details
|
||||
//
|
||||
// See https://periph.io/device/ssd1306/ for more details about the device.
|
||||
//
|
||||
// Datasheets
|
||||
//
|
||||
// Product page:
|
||||
// http://www.solomon-systech.com/en/product/display-ic/oled-driver-controller/ssd1306/
|
||||
//
|
||||
// https://cdn-shop.adafruit.com/datasheets/SSD1306.pdf
|
||||
//
|
||||
// "DM-OLED096-624": https://drive.google.com/file/d/0B5lkVYnewKTGaEVENlYwbDkxSGM/view
|
||||
//
|
||||
// "ssd1306": https://drive.google.com/file/d/0B5lkVYnewKTGYzhyWWp0clBMR1E/view
|
||||
package ssd1306
|
||||
@ -0,0 +1,14 @@
|
||||
// Copyright 2016 The Periph Authors. All rights reserved.
|
||||
// Use of this source code is governed under the Apache License, Version 2.0
|
||||
// that can be found in the LICENSE file.
|
||||
|
||||
// Package tm1637 controls a TM1637 device over GPIO pins.
|
||||
//
|
||||
// More details
|
||||
//
|
||||
// See https://periph.io/device/tm1637/ for more details about the device.
|
||||
//
|
||||
// Datasheet
|
||||
//
|
||||
// http://olimex.cl/website_MCI/static/documents/Datasheet_TM1637.pdf
|
||||
package tm1637
|
||||
Loading…
Reference in New Issue