001package com.pi4j.io.w1; 002 003/* 004 * #%L 005 * ********************************************************************** 006 * ORGANIZATION : Pi4J 007 * PROJECT : Pi4J :: Java Library (Core) 008 * FILENAME : W1DeviceType.java 009 * 010 * This file is part of the Pi4J project. More information about 011 * this project can be found here: https://www.pi4j.com/ 012 * ********************************************************************** 013 * %% 014 * Copyright (C) 2012 - 2019 Pi4J 015 * %% 016 * This program is free software: you can redistribute it and/or modify 017 * it under the terms of the GNU Lesser General Public License as 018 * published by the Free Software Foundation, either version 3 of the 019 * License, or (at your option) any later version. 020 * 021 * This program is distributed in the hope that it will be useful, 022 * but WITHOUT ANY WARRANTY; without even the implied warranty of 023 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 024 * GNU General Lesser Public License for more details. 025 * 026 * You should have received a copy of the GNU General Lesser Public 027 * License along with this program. If not, see 028 * <http://www.gnu.org/licenses/lgpl-3.0.html>. 029 * #L% 030 */ 031 032import java.io.File; 033 034/** 035 * 036 * http://en.wikipedia.org/wiki/1-Wire 037 * @author Peter Schuebl 038 */ 039public interface W1DeviceType { 040 041 /** 042 * Returns the FID of the W1 device e.g. 0x28 for DS18B20 043 * 044 * Each device has 48 bit (six bytes) globally unique address where last eight bits are 045 * CRC of first 56 bits. First byte stores a device family code, that identifies device type. 046 * 047 * @return the family id of the device 048 */ 049 int getDeviceFamilyCode(); 050 051 /** 052 * Gets the implementation class of the device which must be a sub-class of W1Device 053 * @return the implementation class 054 */ 055 Class<? extends W1Device> getDeviceClass(); 056 057 /** 058 * Creates a new instance of a concrete device. 059 * @param deviceDir 060 * @return 061 */ 062 W1Device create(File deviceDir); 063 064}