me.legrange.swap.SwapMessage Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of panstamp Show documentation

A Java library for working with a network of panStamp Arduino devices

The newest version!

package me.legrange.swap;

/**
 * A SWAP message sent or received via the SWAP modem application.
 *
 * @since 1.0
 * @author Gideon le Grange https://github.com/GideonLeGrange *
 */
public interface SwapMessage {
    
    /** Types of SWAP messages */
    public enum Type { QUERY(1), COMMAND(2), STATUS(0); 
        
        private Type(int function) {
            this.function = function;
        }
        
        public int function() { 
            return function;
        }
        
        private final int function;
        
    }
    
    /** Maximum register ID for standard SWAP messages */
    public static final int MAX_STANDARD_REGISTER = 10;
    
    Type getType();

    /**
     * Get the SWAP function code for this message. Query = 1, Command = 2 and Status = 0.
     * 
     * @return The function code.
     */
    int getFunction();

    int getHops();

    int getLqi();

    int getReceiver();

    int getRegisterAddress();

    int getRegisterID();

    byte[] getRegisterValue();

    int getRssi();

    int getSecurity();

    int getSecurityNonce();

    int getSender();

    boolean isExtended();

    boolean isStandardRegister();
    
    String getText();
    
}