001package com.pi4j.io.i2c;
002
003/*
004 * #%L
005 * **********************************************************************
006 * ORGANIZATION  :  Pi4J
007 * PROJECT       :  Pi4J :: Java Library (Core)
008 * FILENAME      :  I2CBus.java  
009 * 
010 * This file is part of the Pi4J project. More information about 
011 * this project can be found here:  http://www.pi4j.com/
012 * **********************************************************************
013 * %%
014 * Copyright (C) 2012 - 2015 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.IOException;
033
034/**
035 * This is abstraction of i2c bus. This interface allows bus to return i2c device.
036 * 
037 * @author Daniel Sendula
038 *
039 */
040
041public interface I2CBus {
042
043    public static final int BUS_0 = 0;
044    public static final int BUS_1 = 1;
045
046    /**
047     * Returns i2c device.
048     * @param address i2c device's address
049     * @return i2c device
050     * 
051     * @throws IOException thrown in case this bus cannot return i2c device.
052     */
053    I2CDevice getDevice(int address) throws IOException;
054    
055    String getFileName();
056    
057    int getFileDescriptor();
058    
059    /**
060     * Closes this bus. This usually means closing underlying file.
061     * 
062     * @throws IOException thrown in case there are problems closing this i2c bus.
063     */
064    void close() throws IOException;
065}