La Suno / Mbed 2 deprecated afero_poc15_180216

Gas Pressure Display Updated Power control for Pressure sensor added

Dependencies:   UniGraphic mbed vt100

afLib/iafLib.h@0:37c8ecde13c2, 2018-02-16 (annotated)

Committer:
Rhyme
Date:
Fri Feb 16 08:27:50 2018 +0000
Revision:
0:37c8ecde13c2
control PSE530 power via PTC5 (pse530_en)

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Rhyme 0:37c8ecde13c2 1 /**
Rhyme 0:37c8ecde13c2 2 * Copyright 2015 Afero, Inc.
Rhyme 0:37c8ecde13c2 3 *
Rhyme 0:37c8ecde13c2 4 * Licensed under the Apache License, Version 2.0 (the "License");
Rhyme 0:37c8ecde13c2 5 * you may not use this file except in compliance with the License.
Rhyme 0:37c8ecde13c2 6 * You may obtain a copy of the License at
Rhyme 0:37c8ecde13c2 7 *
Rhyme 0:37c8ecde13c2 8 * http://www.apache.org/licenses/LICENSE-2.0
Rhyme 0:37c8ecde13c2 9 *
Rhyme 0:37c8ecde13c2 10 * Unless required by applicable law or agreed to in writing, software
Rhyme 0:37c8ecde13c2 11 * distributed under the License is distributed on an "AS IS" BASIS,
Rhyme 0:37c8ecde13c2 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
Rhyme 0:37c8ecde13c2 13 * See the License for the specific language governing permissions and
Rhyme 0:37c8ecde13c2 14 * limitations under the License.
Rhyme 0:37c8ecde13c2 15 */
Rhyme 0:37c8ecde13c2 16
Rhyme 0:37c8ecde13c2 17 /**
Rhyme 0:37c8ecde13c2 18 * afLib public interface
Rhyme 0:37c8ecde13c2 19 *
Rhyme 0:37c8ecde13c2 20 * This file defines everything your application should need for commuinicating with the Afero ASR-1 radio module.
Rhyme 0:37c8ecde13c2 21 * Is there is anything missing from this file, please post a request on the developer forum and we will see what
Rhyme 0:37c8ecde13c2 22 * we can do.
Rhyme 0:37c8ecde13c2 23 */
Rhyme 0:37c8ecde13c2 24 #ifndef AFLIB_IAFLIB_H
Rhyme 0:37c8ecde13c2 25 #define AFLIB_IAFLIB_H
Rhyme 0:37c8ecde13c2 26
Rhyme 0:37c8ecde13c2 27 #include "mbed.h"
Rhyme 0:37c8ecde13c2 28 #include <string>
Rhyme 0:37c8ecde13c2 29 using namespace std;
Rhyme 0:37c8ecde13c2 30 #include "afErrors.h"
Rhyme 0:37c8ecde13c2 31 #include "afSPI.h"
Rhyme 0:37c8ecde13c2 32
Rhyme 0:37c8ecde13c2 33 #if defined (TARGET_TEENSY3_1)
Rhyme 0:37c8ecde13c2 34 #include "USBSerial.h"
Rhyme 0:37c8ecde13c2 35 #endif
Rhyme 0:37c8ecde13c2 36
Rhyme 0:37c8ecde13c2 37 #define afMINIMUM_TIME_BETWEEN_REQUESTS 1000
Rhyme 0:37c8ecde13c2 38
Rhyme 0:37c8ecde13c2 39 #define MAX_ATTRIBUTE_SIZE 255
Rhyme 0:37c8ecde13c2 40
Rhyme 0:37c8ecde13c2 41 typedef void (*isr)();
Rhyme 0:37c8ecde13c2 42 typedef void (*onAttributeSet)(const uint8_t requestId, const uint16_t attributeId, const uint16_t valueLen, const uint8_t *value);
Rhyme 0:37c8ecde13c2 43 typedef void (*onAttributeSetComplete)(const uint8_t requestId, const uint16_t attributeId, const uint16_t valueLen, const uint8_t *value);
Rhyme 0:37c8ecde13c2 44
Rhyme 0:37c8ecde13c2 45 class iafLib {
Rhyme 0:37c8ecde13c2 46 public:
Rhyme 0:37c8ecde13c2 47 /**
Rhyme 0:37c8ecde13c2 48 * create
Rhyme 0:37c8ecde13c2 49 *
Rhyme 0:37c8ecde13c2 50 * Create an instance of the afLib object. The afLib is a singleton. Calling this method multiple
Rhyme 0:37c8ecde13c2 51 * times will return the same instance.
Rhyme 0:37c8ecde13c2 52 *
Rhyme 0:37c8ecde13c2 53 * @param mcuInterrupt The Arduino interrupt to be used (returned from digitalPinToInterrupt)
Rhyme 0:37c8ecde13c2 54 * @param isrWrapper This is the isr method that must be defined in your sketch
Rhyme 0:37c8ecde13c2 55 * @param attrSet Callback for notification of attribute set requests
Rhyme 0:37c8ecde13c2 56 * @param attrSetComplete Callback for notification of attribute set request completions
Rhyme 0:37c8ecde13c2 57 * @return iafLib * Instance of iafLib
Rhyme 0:37c8ecde13c2 58 */
Rhyme 0:37c8ecde13c2 59 static iafLib * create(PinName mcuInterrupt, isr isrWrapper,
Rhyme 0:37c8ecde13c2 60 onAttributeSet attrSet, onAttributeSetComplete attrSetComplete, afSPI *theSPI);
Rhyme 0:37c8ecde13c2 61
Rhyme 0:37c8ecde13c2 62 //wsugi 20161128
Rhyme 0:37c8ecde13c2 63 static void destroy();
Rhyme 0:37c8ecde13c2 64
Rhyme 0:37c8ecde13c2 65 /**
Rhyme 0:37c8ecde13c2 66 * loop
Rhyme 0:37c8ecde13c2 67 *
Rhyme 0:37c8ecde13c2 68 * Called by the loop() method in your sketch to give afLib some CPU time
Rhyme 0:37c8ecde13c2 69 */
Rhyme 0:37c8ecde13c2 70 virtual void loop(void) = 0;
Rhyme 0:37c8ecde13c2 71
Rhyme 0:37c8ecde13c2 72 /**
Rhyme 0:37c8ecde13c2 73 * getAttribute
Rhyme 0:37c8ecde13c2 74 *
Rhyme 0:37c8ecde13c2 75 * Request the value of an attribute be returned from the ASR-1.
Rhyme 0:37c8ecde13c2 76 * Value will be returned in the attrSetComplete callback.
Rhyme 0:37c8ecde13c2 77 */
Rhyme 0:37c8ecde13c2 78 virtual int getAttribute(const uint16_t attrId) = 0;
Rhyme 0:37c8ecde13c2 79
Rhyme 0:37c8ecde13c2 80 /**
Rhyme 0:37c8ecde13c2 81 * setAttribute
Rhyme 0:37c8ecde13c2 82 *
Rhyme 0:37c8ecde13c2 83 * Request setting an attribute.
Rhyme 0:37c8ecde13c2 84 * For MCU attributes, the attribute value will be updated.
Rhyme 0:37c8ecde13c2 85 * For IO attributes, the attribute value will be updated, and then onAttrSetComplete will be called.
Rhyme 0:37c8ecde13c2 86 */
Rhyme 0:37c8ecde13c2 87 virtual int setAttributeBool(const uint16_t attrId, const bool value) = 0;
Rhyme 0:37c8ecde13c2 88
Rhyme 0:37c8ecde13c2 89 virtual int setAttribute8(const uint16_t attrId, const int8_t value) = 0;
Rhyme 0:37c8ecde13c2 90
Rhyme 0:37c8ecde13c2 91 virtual int setAttribute16(const uint16_t attrId, const int16_t value) = 0;
Rhyme 0:37c8ecde13c2 92
Rhyme 0:37c8ecde13c2 93 virtual int setAttribute32(const uint16_t attrId, const int32_t value) = 0;
Rhyme 0:37c8ecde13c2 94
Rhyme 0:37c8ecde13c2 95 virtual int setAttribute64(const uint16_t attrId, const int64_t value) = 0;
Rhyme 0:37c8ecde13c2 96
Rhyme 0:37c8ecde13c2 97 virtual int setAttribute(const uint16_t attrId, const string &value) = 0;
Rhyme 0:37c8ecde13c2 98
Rhyme 0:37c8ecde13c2 99 virtual int setAttribute(const uint16_t attrId, const uint16_t valueLen, const char *value) = 0;
Rhyme 0:37c8ecde13c2 100
Rhyme 0:37c8ecde13c2 101 virtual int setAttribute(const uint16_t attrId, const uint16_t valueLen, const uint8_t *value) = 0;
Rhyme 0:37c8ecde13c2 102
Rhyme 0:37c8ecde13c2 103 /**
Rhyme 0:37c8ecde13c2 104 * setAttributeComplete
Rhyme 0:37c8ecde13c2 105 *
Rhyme 0:37c8ecde13c2 106 * Call this in response to an onAttrSet. This lets the ASR-1 know that the set request has been handled.
Rhyme 0:37c8ecde13c2 107 */
Rhyme 0:37c8ecde13c2 108 virtual int setAttributeComplete(uint8_t requestId, const uint16_t attrId, const uint16_t valueLen, const uint8_t *value) = 0;
Rhyme 0:37c8ecde13c2 109
Rhyme 0:37c8ecde13c2 110 /**
Rhyme 0:37c8ecde13c2 111 * isIdle
Rhyme 0:37c8ecde13c2 112 *
Rhyme 0:37c8ecde13c2 113 * Call to find out of the ASR-1 is currently handling a request.
Rhyme 0:37c8ecde13c2 114 *
Rhyme 0:37c8ecde13c2 115 * @return true if an operation is in progress
Rhyme 0:37c8ecde13c2 116 */
Rhyme 0:37c8ecde13c2 117 virtual bool isIdle() = 0;
Rhyme 0:37c8ecde13c2 118
Rhyme 0:37c8ecde13c2 119 /**
Rhyme 0:37c8ecde13c2 120 * mcuISR
Rhyme 0:37c8ecde13c2 121 *
Rhyme 0:37c8ecde13c2 122 * Called by your sketch to pass the interrupt along to afLib.
Rhyme 0:37c8ecde13c2 123 */
Rhyme 0:37c8ecde13c2 124 virtual void mcuISR() = 0;
Rhyme 0:37c8ecde13c2 125 };
Rhyme 0:37c8ecde13c2 126 #endif //AFLIB_IAFLIB_H