propcodes.java

Open DMT GPS server source code

// ----------------------------------------------------------------------------
// Copyright 2006-2008, Martin D. Flynn
// All rights reserved
// ----------------------------------------------------------------------------
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// 
// http://www.apache.org/licenses/LICENSE-2.0
// 
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
// ----------------------------------------------------------------------------
// Change History:
//  2007/02/25  Martin D. Flynn
//     -Initial release
//  2008/02/04  Martin D. Flynn
//     -Added description to property attributes
//  2008/05/12  Martin D. Flynn
//     -Updated to Java 5.
// ----------------------------------------------------------------------------
package org.opendmtp.codes;

import java.util.HashMap;

import org.opengts.util.*;

public class PropCodes
{

    // ------------------------------------------------------------------------
    // Geozone admin property commands (see PROP_CMD_GEOF_ADMIN[F542])

    public static final int GEOF_CMD_ADD_STD_2              = 0x10;
    public static final int GEOF_CMD_ADD_HIGH_2             = 0x11;
    public static final int GEOF_CMD_ADD_STD_N              = 0x1E;
    public static final int GEOF_CMD_ADD_HIGH_N             = 0x1F;
    public static final int GEOF_CMD_REMOVE                 = 0x20;
    public static final int GEOF_CMD_SAVE                   = 0x30;

    // ------------------------------------------------------------------------
    // Property attribute types

    public static final int TYPE_TYPE_MASK                  = 0xF000;
    public static final int TYPE_SIZE_MASK                  = 0x000F;

    public static final int TYPE_COMMAND                    = 0x1000;
    public static final int TYPE_STRING                     = 0x2000;
    public static final int TYPE_BINARY                     = 0x3000;
    public static final int TYPE_GPS                        = 0x4000;
    public static final int TYPE_BOOLEAN                    = 0x5000;
    public static final int TYPE_NUMERIC                    = 0x6000;
    
    public static final int TYPE_DEC                        = 0x0100;
    public static final int TYPE_SIGNED                     = 0x0800;

    public static final int TYPE_UINT8                      = TYPE_NUMERIC | 0x0001;
    public static final int TYPE_UINT16                     = TYPE_NUMERIC | 0x0002;
    public static final int TYPE_INT16                      = TYPE_NUMERIC | 0x0002 | TYPE_SIGNED;
    public static final int TYPE_UINT32                     = TYPE_NUMERIC | 0x0004;
    public static final int TYPE_UDEC16                     = TYPE_NUMERIC | 0x0002 | TYPE_DEC;
    public static final int TYPE_DEC16                      = TYPE_NUMERIC | 0x0002 | TYPE_DEC | TYPE_SIGNED;

    // ------------------------------------------------------------------------
    // OpenDMTP properties

    // --- Transport media port config
    public static final int PROP_CFG_XPORT_PORT             = 0xEF11;
    public static final int PROP_CFG_XPORT_BPS              = 0xEF12;
    public static final int PROP_CFG_XPORT_DEBUG            = 0xEF1D;
   
    // --- GPS port config
    public static final int PROP_CFG_GPS_PORT               = 0xEF21;
    public static final int PROP_CFG_GPS_BPS                = 0xEF22;
    public static final int PROP_CFG_GPS_MODEL              = 0xEF2A;  // was 0xEF22
    public static final int PROP_CFG_GPS_DEBUG              = 0xEF2D;
    
    // --- General serial port 0 config
    public static final int PROP_CFG_SERIAL0_PORT           = 0xEF31;
    public static final int PROP_CFG_SERIAL0_BPS            = 0xEF32;
    public static final int PROP_CFG_SERIAL0_DEBUG          = 0xEF3D;
    
    // --- General serial port 1 config
    public static final int PROP_CFG_SERIAL1_PORT           = 0xEF41;
    public static final int PROP_CFG_SERIAL1_BPS            = 0xEF42;
    public static final int PROP_CFG_SERIAL1_DEBUG          = 0xEF4D;
    
    // --- General serial port 2 config
    public static final int PROP_CFG_SERIAL2_PORT           = 0xEF51;
    public static final int PROP_CFG_SERIAL2_BPS            = 0xEF52;
    public static final int PROP_CFG_SERIAL2_DEBUG          = 0xEF5D;
    
    // --- General serial port 3 config
    public static final int PROP_CFG_SERIAL3_PORT           = 0xEF61;
    public static final int PROP_CFG_SERIAL3_BPS            = 0xEF62;
    public static final int PROP_CFG_SERIAL3_DEBUG          = 0xEF6D;

    // --- Command properties
    public static final int PROP_CMD_SAVE_PROPS             = 0xF000;
    public static final int PROP_CMD_AUTHORIZE              = 0xF002;
    public static final int PROP_CMD_STATUS_EVENT           = 0xF011;
    public static final int PROP_CMD_SET_OUTPUT             = 0xF031;
    public static final int PROP_CMD_RESET                  = 0xF0FF;

    // --- State properties
    public static final int PROP_STATE_PROTOCOL             = 0xF100;
    public static final int PROP_STATE_FIRMWARE             = 0xF101;
    public static final int PROP_STATE_COPYRIGHT            = 0xF107;
    public static final int PROP_STATE_SERIAL               = 0xF110;
    public static final int PROP_STATE_UNIQUE_ID            = 0xF112;
    public static final int PROP_STATE_ACCOUNT_ID           = 0xF114;
    public static final int PROP_STATE_DEVICE_ID            = 0xF115;
    public static final int PROP_STATE_USER_ID              = 0xF117;
    public static final int PROP_STATE_USER_TIME            = 0xF118;
    public static final int PROP_STATE_TIME                 = 0xF121;
    public static final int PROP_STATE_GPS                  = 0xF123;
    public static final int PROP_STATE_GPS_DIAGNOSTIC       = 0xF124;
    public static final int PROP_STATE_QUEUED_EVENTS        = 0xF131;
    public static final int PROP_STATE_DEV_DIAGNOSTIC       = 0xF141;

    // --- Communication properties
    public static final int PROP_COMM_SPEAK_FIRST           = 0xF303;
    public static final int PROP_COMM_FIRST_BRIEF           = 0xF305;
    public static final int PROP_COMM_FAILURE_DELAY         = 0xF309;
    public static final int PROP_COMM_MAX_CONNECTIONS       = 0xF311;
    public static final int PROP_COMM_MIN_XMIT_DELAY        = 0xF312;
    public static final int PROP_COMM_MIN_XMIT_RATE         = 0xF313;
    public static final int PROP_COMM_MAX_XMIT_RATE         = 0xF315;
    public static final int PROP_COMM_MAX_DUP_EVENTS        = 0xF317;
    public static final int PROP_COMM_MAX_SIM_EVENTS        = 0xF318;

    // --- Communication connection properties:
    public static final int PROP_COMM_SETTINGS              = 0xF3A0;
    public static final int PROP_COMM_DMTP_HOST             = 0xF3A1;
    public static final int PROP_COMM_DMTP_PORT             = 0xF3A2;
    public static final int PROP_COMM_DNS_1                 = 0xF3A3;
    public static final int PROP_COMM_DNS_2                 = 0xF3A4;
    public static final int PROP_COMM_CONNECTION            = 0xF3A5;
    public static final int PROP_COMM_APN_NAME              = 0xF3A6;
    public static final int PROP_COMM_APN_SERVER            = 0xF3A7;
    public static final int PROP_COMM_APN_USER              = 0xF3A8;
    public static final int PROP_COMM_APN_PASSWORD          = 0xF3A9;
    public static final int PROP_COMM_APN_PHONE             = 0xF3AA;
    public static final int PROP_COMM_APN_SETTINGS          = 0xF3AC;
    public static final int PROP_COMM_MIN_SIGNAL            = 0xF3AD;
    public static final int PROP_COMM_ACCESS_PIN            = 0xF3AF;

    // --- Packet/Data format properties:
    public static final int PROP_COMM_CUSTOM_FORMATS        = 0xF3C0;
    public static final int PROP_COMM_ENCODINGS             = 0xF3C1;
    public static final int PROP_COMM_BYTES_READ            = 0xF3F1;
    public static final int PROP_COMM_BYTES_WRITTEN         = 0xF3F2;
    
    // --- GPS config properties:
    public static final int PROP_GPS_SAMPLE_RATE            = 0xF511;
    public static final int PROP_GPS_ACQUIRE_WAIT           = 0xF512;
    public static final int PROP_GPS_EXPIRATION             = 0xF513;
    public static final int PROP_GPS_CLOCK_DELTA            = 0xF515;
    public static final int PROP_GPS_ACCURACY               = 0xF521;
    public static final int PROP_GPS_MIN_SPEED              = 0xF522;
    public static final int PROP_GPS_DISTANCE_DELTA         = 0xF531;

    // --- Geofence properties:
    public static final int PROP_CMD_GEOF_ADMIN             = 0xF542;
    public static final int PROP_GEOF_COUNT                 = 0xF547;
    public static final int PROP_GEOF_VERSION               = 0xF548;
    public static final int PROP_GEOF_ARRIVE_DELAY          = 0xF54A;
    public static final int PROP_GEOF_DEPART_DELAY          = 0xF54D;
    public static final int PROP_GEOF_CURRENT               = 0xF551;

    // --- GeoCorr properties:
    public static final int PROP_CMD_GEOC_ADMIN             = 0xF562;
    public static final int PROP_GEOC_ACTIVE_ID             = 0xF567;
    public static final int PROP_GEOC_VIOLATION_INTRVL      = 0xF56A;
    public static final int PROP_GEOC_VIOLATION_COUNT       = 0xF56D;

    // --- Motion properties:
    public static final int PROP_MOTION_START_TYPE          = 0xF711;
    public static final int PROP_MOTION_START               = 0xF712;
    public static final int PROP_MOTION_IN_MOTION           = 0xF713;
    public static final int PROP_MOTION_STOP                = 0xF714;
    public static final int PROP_MOTION_STOP_TYPE           = 0xF715;
    public static final int PROP_MOTION_DORMANT_INTRVL      = 0xF716;
    public static final int PROP_MOTION_DORMANT_COUNT       = 0xF717;
    public static final int PROP_MOTION_EXCESS_SPEED        = 0xF721;  // Excess speed (0.1 kph)
    public static final int PROP_MOTION_MOVING_INTRVL       = 0xF725;
    
    // --- Odometer properties:
    public static final int PROP_ODOMETER_0_VALUE           = 0xF770;
    public static final int PROP_ODOMETER_1_VALUE           = 0xF771;
    public static final int PROP_ODOMETER_2_VALUE           = 0xF772;
    public static final int PROP_ODOMETER_3_VALUE           = 0xF773;
    public static final int PROP_ODOMETER_4_VALUE           = 0xF774;
    public static final int PROP_ODOMETER_5_VALUE           = 0xF775;
    public static final int PROP_ODOMETER_6_VALUE           = 0xF776;
    public static final int PROP_ODOMETER_7_VALUE           = 0xF777;
    public static final int PROP_ODOMETER_0_LIMIT           = 0xF780;
    public static final int PROP_ODOMETER_1_LIMIT           = 0xF781;
    public static final int PROP_ODOMETER_2_LIMIT           = 0xF782;
    public static final int PROP_ODOMETER_3_LIMIT           = 0xF783;
    public static final int PROP_ODOMETER_4_LIMIT           = 0xF784;
    public static final int PROP_ODOMETER_5_LIMIT           = 0xF785;
    public static final int PROP_ODOMETER_6_LIMIT           = 0xF786;
    public static final int PROP_ODOMETER_7_LIMIT           = 0xF787;
    public static final int PROP_ODOMETER_0_GPS             = 0xF790;
    public static final int PROP_ODOMETER_1_GPS             = 0xF791;
    public static final int PROP_ODOMETER_2_GPS             = 0xF792;
    public static final int PROP_ODOMETER_3_GPS             = 0xF793;
    public static final int PROP_ODOMETER_4_GPS             = 0xF794;
    public static final int PROP_ODOMETER_5_GPS             = 0xF795;
    public static final int PROP_ODOMETER_6_GPS             = 0xF796;
    public static final int PROP_ODOMETER_7_GPS             = 0xF797;
    
    // --- Digital input properties:
    public static final int PROP_INPUT_STATE                = 0xF901;
    public static final int PROP_INPUT_CONFIG_0             = 0xF910;
    public static final int PROP_INPUT_CONFIG_1             = 0xF911;
    public static final int PROP_INPUT_CONFIG_2             = 0xF912;
    public static final int PROP_INPUT_CONFIG_3             = 0xF913;
    public static final int PROP_INPUT_CONFIG_4             = 0xF914;
    public static final int PROP_INPUT_CONFIG_5             = 0xF915;
    public static final int PROP_INPUT_CONFIG_6             = 0xF916;
    public static final int PROP_INPUT_CONFIG_7             = 0xF917;
    public static final int PROP_INPUT_CONFIG_8             = 0xF918;
    public static final int PROP_INPUT_CONFIG_9             = 0xF919;
    public static final int PROP_INPUT_CONFIG_A             = 0xF91A;
    public static final int PROP_INPUT_CONFIG_B             = 0xF91B;
    public static final int PROP_INPUT_CONFIG_C             = 0xF91C;
    public static final int PROP_INPUT_CONFIG_D             = 0xF91D;
    public static final int PROP_INPUT_CONFIG_E             = 0xF91E;
    public static final int PROP_INPUT_CONFIG_F             = 0xF91F;
    
    // --- Digital output properties:
    public static final int PROP_OUTPUT_CONFIG_0            = 0xF930;
    public static final int PROP_OUTPUT_CONFIG_1            = 0xF931;
    public static final int PROP_OUTPUT_CONFIG_2            = 0xF932;
    public static final int PROP_OUTPUT_CONFIG_3            = 0xF933;
    public static final int PROP_OUTPUT_CONFIG_4            = 0xF934;
    public static final int PROP_OUTPUT_CONFIG_5            = 0xF935;
    public static final int PROP_OUTPUT_CONFIG_6            = 0xF936;
    public static final int PROP_OUTPUT_CONFIG_7            = 0xF937;
    
    // --- Elapsed time properties:
    public static final int PROP_ELAPSED_0_VALUE            = 0xF970;
    public static final int PROP_ELAPSED_1_VALUE            = 0xF971;
    public static final int PROP_ELAPSED_2_VALUE            = 0xF972;
    public static final int PROP_ELAPSED_3_VALUE            = 0xF973;
    public static final int PROP_ELAPSED_4_VALUE            = 0xF974;
    public static final int PROP_ELAPSED_5_VALUE            = 0xF975;
    public static final int PROP_ELAPSED_6_VALUE            = 0xF976;
    public static final int PROP_ELAPSED_7_VALUE            = 0xF977;
    public static final int PROP_ELAPSED_0_LIMIT            = 0xF980;
    public static final int PROP_ELAPSED_1_LIMIT            = 0xF981;
    public static final int PROP_ELAPSED_2_LIMIT            = 0xF982;
    public static final int PROP_ELAPSED_3_LIMIT            = 0xF983;
    public static final int PROP_ELAPSED_4_LIMIT            = 0xF984;
    public static final int PROP_ELAPSED_5_LIMIT            = 0xF985;
    public static final int PROP_ELAPSED_6_LIMIT            = 0xF986;
    public static final int PROP_ELAPSED_7_LIMIT            = 0xF987;
    
    // --- Sensor configuration properties:
    public static final int PROP_UNDERVOLTAGE_LIMIT         = 0xFB01;
    public static final int PROP_SENSOR_CONFIG_0            = 0xFB10;
    public static final int PROP_SENSOR_CONFIG_1            = 0xFB11;
    public static final int PROP_SENSOR_CONFIG_2            = 0xFB12;
    public static final int PROP_SENSOR_CONFIG_3            = 0xFB13;
    public static final int PROP_SENSOR_CONFIG_4            = 0xFB14;
    public static final int PROP_SENSOR_CONFIG_5            = 0xFB15;
    public static final int PROP_SENSOR_CONFIG_6            = 0xFB16;
    public static final int PROP_SENSOR_CONFIG_7            = 0xFB17;
    public static final int PROP_SENSOR_RANGE_0             = 0xFB20;
    public static final int PROP_SENSOR_RANGE_1             = 0xFB21;
    public static final int PROP_SENSOR_RANGE_2             = 0xFB22;
    public static final int PROP_SENSOR_RANGE_3             = 0xFB23;
    public static final int PROP_SENSOR_RANGE_4             = 0xFB24;
    public static final int PROP_SENSOR_RANGE_5             = 0xFB25;
    public static final int PROP_SENSOR_RANGE_6             = 0xFB26;
    public static final int PROP_SENSOR_RANGE_7             = 0xFB27;
    
    // --- Temperature configuration:
    public static final int PROP_TEMP_SAMPLE_INTRVL         = 0xFB60;
    public static final int PROP_TEMP_REPORT_INTRVL         = 0xFB63;