├── firmwares
└── .gitkeep
├── hardware
├── 407.STL
├── BOM.xlsx
└── Gerber_PCB_1.6mm_V1.zip
├── images
├── G407.jpg
├── geiger.jpg
├── sbm-20.jpg
├── z2m_about.png
├── z2m_exposes.png
├── DIYRuZ_GEIGER_05.jpg
├── DIYRuZ_GEIGER_06.jpg
├── DIYRuZ_GEIGER_07.jpg
├── DIYRuZ_GEIGER_08.jpg
├── DIYRuZ_GEIGER_09.jpg
├── DIYRuZ_GEIGER_10.jpg
├── DIYRuZ_GEIGER_11.jpg
├── DIYRuZ_GEIGER_12.jpg
├── DIYRuZ_GEIGER_13.jpg
├── DIYRuZ_GEIGER_16.jpg
├── DIYRuZ_GEIGER_17.jpg
├── DIYRuZ_GEIGER_19.jpg
├── DIYRuZ_GEIGER_20.jpg
└── DIYRuZ_GEIGER_21.jpg
├── CC2530DB
├── settings
│ ├── GenericApp.reggroups
│ └── GenericApp.dnx
└── GenericApp.eww
├── Source
├── version.h
├── calculate_urh.h
├── isr_counter.h
├── calculate_urh.c
├── preinclude.h
├── OSAL_App.c
├── zcl_app.h
├── isr_counter.c
├── zcl_app_data.c
├── zcl_app.c
└── hal_board_cfg.h
├── .gitmodules
├── .release-it.yml
├── .clang-format
├── ver.py
├── .gitignore
├── .vscode
└── c_cpp_properties.json
├── README_ru.md
├── README.md
└── LICENSE
/firmwares/.gitkeep:
--------------------------------------------------------------------------------
1 |
2 |
--------------------------------------------------------------------------------
/hardware/407.STL:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/xyzroe/geiger/master/hardware/407.STL
--------------------------------------------------------------------------------
/images/G407.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/xyzroe/geiger/master/images/G407.jpg
--------------------------------------------------------------------------------
/hardware/BOM.xlsx:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/xyzroe/geiger/master/hardware/BOM.xlsx
--------------------------------------------------------------------------------
/images/geiger.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/xyzroe/geiger/master/images/geiger.jpg
--------------------------------------------------------------------------------
/images/sbm-20.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/xyzroe/geiger/master/images/sbm-20.jpg
--------------------------------------------------------------------------------
/CC2530DB/settings/GenericApp.reggroups:
--------------------------------------------------------------------------------
1 | group = "io", "P0"
2 | group = "Unnamed2", "P1"
3 |
--------------------------------------------------------------------------------
/images/z2m_about.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/xyzroe/geiger/master/images/z2m_about.png
--------------------------------------------------------------------------------
/Source/version.h:
--------------------------------------------------------------------------------
1 | extern const uint8 zclApp_DateCode[];
2 | extern const char zclApp_DateCodeNT[];
--------------------------------------------------------------------------------
/images/z2m_exposes.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/xyzroe/geiger/master/images/z2m_exposes.png
--------------------------------------------------------------------------------
/images/DIYRuZ_GEIGER_05.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/xyzroe/geiger/master/images/DIYRuZ_GEIGER_05.jpg
--------------------------------------------------------------------------------
/images/DIYRuZ_GEIGER_06.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/xyzroe/geiger/master/images/DIYRuZ_GEIGER_06.jpg
--------------------------------------------------------------------------------
/images/DIYRuZ_GEIGER_07.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/xyzroe/geiger/master/images/DIYRuZ_GEIGER_07.jpg
--------------------------------------------------------------------------------
/images/DIYRuZ_GEIGER_08.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/xyzroe/geiger/master/images/DIYRuZ_GEIGER_08.jpg
--------------------------------------------------------------------------------
/images/DIYRuZ_GEIGER_09.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/xyzroe/geiger/master/images/DIYRuZ_GEIGER_09.jpg
--------------------------------------------------------------------------------
/images/DIYRuZ_GEIGER_10.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/xyzroe/geiger/master/images/DIYRuZ_GEIGER_10.jpg
--------------------------------------------------------------------------------
/images/DIYRuZ_GEIGER_11.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/xyzroe/geiger/master/images/DIYRuZ_GEIGER_11.jpg
--------------------------------------------------------------------------------
/images/DIYRuZ_GEIGER_12.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/xyzroe/geiger/master/images/DIYRuZ_GEIGER_12.jpg
--------------------------------------------------------------------------------
/images/DIYRuZ_GEIGER_13.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/xyzroe/geiger/master/images/DIYRuZ_GEIGER_13.jpg
--------------------------------------------------------------------------------
/images/DIYRuZ_GEIGER_16.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/xyzroe/geiger/master/images/DIYRuZ_GEIGER_16.jpg
--------------------------------------------------------------------------------
/images/DIYRuZ_GEIGER_17.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/xyzroe/geiger/master/images/DIYRuZ_GEIGER_17.jpg
--------------------------------------------------------------------------------
/images/DIYRuZ_GEIGER_19.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/xyzroe/geiger/master/images/DIYRuZ_GEIGER_19.jpg
--------------------------------------------------------------------------------
/images/DIYRuZ_GEIGER_20.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/xyzroe/geiger/master/images/DIYRuZ_GEIGER_20.jpg
--------------------------------------------------------------------------------
/images/DIYRuZ_GEIGER_21.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/xyzroe/geiger/master/images/DIYRuZ_GEIGER_21.jpg
--------------------------------------------------------------------------------
/.gitmodules:
--------------------------------------------------------------------------------
1 | [submodule "zstack-lib"]
2 | path = zstack-lib
3 | url = git@github.com:diyruz/zstack-lib.git
4 |
--------------------------------------------------------------------------------
/hardware/Gerber_PCB_1.6mm_V1.zip:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/xyzroe/geiger/master/hardware/Gerber_PCB_1.6mm_V1.zip
--------------------------------------------------------------------------------
/.release-it.yml:
--------------------------------------------------------------------------------
1 | git:
2 | requireCleanWorkingDir: false
3 | github:
4 | release: true
5 | assets: ["firmwares/DIYRuZ_*.hex"]
6 | draft: false
--------------------------------------------------------------------------------
/.clang-format:
--------------------------------------------------------------------------------
1 | ---
2 | # We'll use defaults from the LLVM style, but with 4 columns indentation.
3 | BasedOnStyle: LLVM
4 | IndentWidth: 4
5 | ColumnLimit: 180
--------------------------------------------------------------------------------
/Source/calculate_urh.h:
--------------------------------------------------------------------------------
1 | #ifndef calculate_urh_h
2 | #define calculate_urh_h
3 | extern uint32 calculate_urh_sbm20(float cps);
4 | extern uint32 calculate_urh_sbm19(float cps);
5 | #endif
--------------------------------------------------------------------------------
/Source/isr_counter.h:
--------------------------------------------------------------------------------
1 | #ifndef ISR_COUNTER_H
2 | #define ISR_COUNTER_H
3 |
4 | typedef void (*isr_counter_CB_t)( uint8 portNum );
5 |
6 |
7 | extern uint16 zclApp_Port0CounterValue;
8 | extern uint16 zclApp_Port1CounterValue;
9 | extern uint16 zclApp_Port2CounterValue;
10 | extern void zclApp_InitCounter(void);
11 |
12 | extern void zclApp_RegisterCounterCallback(isr_counter_CB_t callback);
13 |
14 |
15 | #endif
--------------------------------------------------------------------------------
/CC2530DB/GenericApp.eww:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | $WS_DIR$\GenericApp.ewp
5 |
6 |
7 |
8 | ALL
9 |
10 | GenericApp
11 | DIYRuZ_Geiger
12 |
13 |
14 | GenericApp
15 | DIYRuZ_Geiger_ED
16 |
17 |
18 |
19 |
20 |
--------------------------------------------------------------------------------
/ver.py:
--------------------------------------------------------------------------------
1 | from datetime import datetime
2 | from os.path import dirname, join
3 | cwd = dirname(__file__)
4 | now = datetime.now()
5 | dt_string = now.strftime("%d/%m/%Y %H:%M")
6 | print("date and time =", dt_string)
7 | with open(join(cwd, './Source/version.c'), 'w') as f:
8 | chars = ["'{0}'".format(char) for char in dt_string]
9 | f.write("""
10 | #ifndef ZCL_APP_VERSION_H
11 | #define ZCL_APP_VERSION_H
12 |
13 | #ifdef __cplusplus
14 | extern "C" {
15 | #endif
16 |
17 | """
18 | )
19 | f.write('#include "version.h"\n')
20 | code = """const uint8 zclApp_DateCode[] = {{ {0}, {1} }};\n""".format(len(chars), ', '.join(chars))
21 | f.write(code)
22 | code = """const char zclApp_DateCodeNT[] = \"{0}\";\n""".format(dt_string)
23 | f.write(code)
24 | f.write("""
25 | #ifdef __cplusplus
26 | }
27 | #endif
28 |
29 | #endif /* ZCL_APP_VERSION_H */
30 | """)
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | # IAR C-STAT and C-RUN
2 | # Comment this out if you use C-Stat or C-Run to compile/analyze your project
3 | *.ewt
4 |
5 | # IAR Debugger files
6 | *.ewd
7 |
8 |
9 | # IAR Settings
10 | **/settings/*.crun
11 | **/settings/*.dbgdt
12 | **/settings/*.cspy
13 | **/settings/*.cspy.*
14 | **/settings/*.xcl
15 | **/settings/*.dni
16 | **/settings/*.wsdt
17 | **/settings/*.wspos
18 |
19 | # IAR Debug Exe
20 | **/CoordinatorEB/Exe/
21 |
22 | # IAR Debug List
23 | **/CoordinatorEB/List
24 |
25 | # IAR Debug Obj
26 | **/CoordinatorEB/Obj/*.pbd
27 | **/CoordinatorEB/Obj/*.pbd.*
28 | **/CoordinatorEB/Obj/*.pbi
29 | **/CoordinatorEB/Obj/*.pbi.*
30 | **/CoordinatorEB/Obj/*.r51
31 |
32 | # Log files
33 | **.log
34 |
35 | # IAR backup files
36 | Backup*
37 |
38 | # IAR .dep files
39 | *.dep
40 |
41 | # Compiled Binaries
42 | *.bin
43 | *.elf
44 | *.map
45 |
46 | # Trash files
47 | *.bak
48 |
49 | # CC2530DB
50 |
51 | CC2530DB/CHDTECH_DEV
52 | CC2530DB/FREEPAD*
53 | CC2530DB/flower
54 | CC2530DB/HAL_BOARD_TARGET
55 | CC2530DB/DIYRuZ*
56 | Source/version.c
57 | !.vscode/
58 | .vscode/settings.json
59 | firmwares/*
60 |
--------------------------------------------------------------------------------
/.vscode/c_cpp_properties.json:
--------------------------------------------------------------------------------
1 | {
2 | "configurations": [{
3 | "name": "Mac",
4 | "forcedInclude": ["${workspaceRoot}/source/preinclude.h"],
5 | "defines": ["HAL_BOARD_CHDTECH_DEV", "HAL_I2C=TRUE", "HAL_I2C_MASTER"],
6 | "includePath": [
7 | "${workspaceRoot}",
8 | "${env:ZSTACK_PATH}/Components/mac/include/",
9 | "${env:ZSTACK_PATH}/Components/mt",
10 | "${env:ZSTACK_PATH}/Components/zmac",
11 | "${env:ZSTACK_PATH}/Components/zmac/f8w",
12 | "${env:ZSTACK_PATH}/Components/osal/include",
13 | "${env:ZSTACK_PATH}/Components/stack/af",
14 | "${env:ZSTACK_PATH}/Components/stack/bdb",
15 | "${env:ZSTACK_PATH}/Components/stack/sec",
16 | "${env:ZSTACK_PATH}/Components/stack/sys",
17 | "${env:ZSTACK_PATH}/Components/stack/zdo",
18 | "${env:ZSTACK_PATH}/Components/stack/GP",
19 | "${env:ZSTACK_PATH}/Components/stack/nwk",
20 | "${env:ZSTACK_PATH}/Components/stack/zcl",
21 | "${env:ZSTACK_PATH}/Components/hal/target/CC2530EB/",
22 | "${env:ZSTACK_PATH}/Components/hal/include/",
23 | "${env:ZSTACK_PATH}/Components/services/saddr/",
24 | "${env:ZSTACK_PATH}/Components/services/sdata/",
25 | "${env:ZSTACK_PATH}/Projects/zstack/ZMain/TI2530DB",
26 | "${env:ZSTACK_PATH}/Projects/zstack/HomeAutomation/Source"
27 | ],
28 | "intelliSenseMode": "clang-x64",
29 | "compilerPath": "/usr/bin/clang",
30 | "cStandard": "c99",
31 | "cppStandard": "c++17"
32 | }],
33 | "version": 4
34 | }
--------------------------------------------------------------------------------
/Source/calculate_urh.c:
--------------------------------------------------------------------------------
1 |
2 | #include "calculate_urh.h"
3 |
4 | #define round(x) ((x)>=0?(long)((x)+0.5):(long)((x)-0.5))
5 |
6 | // Линейная аппроксимация на основе графика из статьи http://sxem.org/2-vse-stati/24-izmereniya/213-radiometr-dozimetr
7 | // https://www.wolframalpha.com/input/?i=linear+fit+%7B200,7200%7D,%7B400,15000%7D
8 | // credit: https://github.com/avdeevsv91/esp_radiation_meter/blob/master/firmware/firmware.c#L78
9 |
10 | uint32 calculate_urh_sbm20(float cps) {
11 | if (cps < 200) {
12 | return round(cps * (36)); // 36
13 | } else if (cps >= 200 && cps < 400) {
14 | return round(cps * ((39 * cps - 600))); // 37.5
15 | } else if (cps >= 400 && cps < 800) {
16 | return round(cps * ((56.25 * cps - 7500))); // 46.875
17 | } else if (cps >= 800 && cps < 1400) {
18 | return round(cps * ((66.6667 * cps - 15833.3))); // 55.357
19 | } else if (cps >= 1400 && cps < 2000) {
20 | return round(cps * ((87.5 * cps - 45000))); // 65
21 | } else {
22 | return 130000; // Предел измерений
23 | }
24 | }
25 |
26 | uint32 calculate_urh_sbm19(float cps) {
27 |
28 | if (cps < 200) {
29 | return round(cps * (9)); // 9
30 | } else if (cps >= 200 && cps < 400) {
31 | return round(cps * ((9.75 * cps - 150))); // 9.375
32 | } else if (cps >= 400 && cps < 800) {
33 | return round(cps * ((14.0625 * cps - 1875))); // 11.719
34 | } else if (cps >= 800 && cps < 1400) {
35 | return round(cps * ((16.6667 * cps - 3958.33))); // 13.839
36 | } else if (cps >= 1400 && cps < 2000) {
37 | return round(cps * ((21.875 * cps - 11250))); // 16.25
38 | } else {
39 | return 130000; // Предел измерений
40 | }
41 | }
--------------------------------------------------------------------------------
/Source/preinclude.h:
--------------------------------------------------------------------------------
1 | #define TC_LINKKEY_JOIN
2 | #define NV_INIT
3 | #define NV_RESTORE
4 |
5 | #define TP2_LEGACY_ZC
6 | // patch sdk
7 | // #define ZDSECMGR_TC_ATTEMPT_DEFAULT_KEY TRUE
8 |
9 | #define NWK_AUTO_POLL
10 | #define MULTICAST_ENABLED FALSE
11 |
12 | #define ZCL_READ
13 | #define ZCL_WRITE
14 | #define ZCL_BASIC
15 | #define ZCL_IDENTIFY
16 | #define ZCL_REPORTING_DEVICE
17 | #define ZCL_ON_OFF
18 |
19 | #define DISABLE_GREENPOWER_BASIC_PROXY
20 | #define BDB_FINDING_BINDING_CAPABILITY_ENABLED 1
21 | #define BDB_REPORTING TRUE
22 |
23 | #ifdef DEFAULT_CHANLIST
24 | #undef DEFAULT_CHANLIST
25 | #endif
26 | #define DEFAULT_CHANLIST 0x07FFF800
27 |
28 | #define HAL_BUZZER FALSE
29 | #define HAL_KEY FALSE
30 |
31 | #define HAL_LED TRUE
32 | #define HAL_ADC FALSE
33 | #define HAL_LCD FALSE
34 |
35 | #define BLINK_LEDS TRUE
36 |
37 | // one of this boards
38 | // #define HAL_BOARD_TARGET
39 | // #define HAL_BOARD_CHDTECH_DEV
40 |
41 | #if !defined(HAL_BOARD_TARGET) && !defined(HAL_BOARD_CHDTECH_DEV)
42 | #error "Board type must be defined"
43 | #endif
44 |
45 | #if defined(HAL_BOARD_TARGET)
46 | #define APP_TX_POWER TX_PWR_PLUS_19
47 | #elif defined(HAL_BOARD_CHDTECH_DEV)
48 | #define APP_TX_POWER TX_PWR_PLUS_4
49 | #define DO_DEBUG_UART
50 | // #define DO_DEBUG_MT
51 | #endif
52 |
53 |
54 |
55 | #ifdef DO_DEBUG_UART
56 | #define HAL_UART TRUE
57 | #define HAL_UART_DMA 1
58 | #define INT_HEAP_LEN (2685 - 0x4B - 0xBB)
59 | #endif
60 |
61 | #ifdef DO_DEBUG_MT
62 | #define HAL_UART TRUE
63 | #define HAL_UART_DMA 1
64 | #define HAL_UART_ISR 2
65 | #define INT_HEAP_LEN (2685 - 0x4B - 0xBB)
66 |
67 | #define MT_TASK
68 |
69 | #define MT_UTIL_FUNC
70 | #define MT_UART_DEFAULT_BAUDRATE HAL_UART_BR_115200
71 | #define MT_UART_DEFAULT_OVERFLOW FALSE
72 |
73 | #define ZTOOL_P1
74 |
75 | #define MT_APP_FUNC
76 | #define MT_APP_CNF_FUNC
77 | #define MT_SYS_FUNC
78 | #define MT_ZDO_FUNC
79 | #define MT_ZDO_MGMT
80 | #define MT_DEBUG_FUNC
81 |
82 | #endif
83 |
84 |
85 | #include "hal_board_cfg.h"
86 |
--------------------------------------------------------------------------------
/Source/OSAL_App.c:
--------------------------------------------------------------------------------
1 | #include "OSAL.h"
2 | #include "OSAL_Tasks.h"
3 | #include "ZComDef.h"
4 | #include "hal_drivers.h"
5 |
6 | #include "APS.h"
7 | #include "ZDApp.h"
8 | #include "nwk.h"
9 |
10 | #if defined ( MT_TASK )
11 | #include "MT.h"
12 | #include "MT_TASK.h"
13 | #endif
14 | // #include "stub_aps.h"
15 |
16 | #include "commissioning.h"
17 | #include "factory_reset.h"
18 | #include "Debug.h"
19 |
20 | // #include "bdb_touchlink_target.h"
21 |
22 | #include "bdb_interface.h"
23 | #include "zcl_app.h"
24 |
25 | const pTaskEventHandlerFn tasksArr[] = {macEventLoop,
26 | nwk_event_loop,
27 | Hal_ProcessEvent,
28 | #if defined( MT_TASK )
29 | MT_ProcessEvent,
30 | #endif
31 | APS_event_loop,
32 | ZDApp_event_loop,
33 | // StubAPS_ProcessEvent,
34 | // touchLinkTarget_event_loop,
35 | zcl_event_loop,
36 | bdb_event_loop,
37 | zclApp_event_loop,
38 | zclCommissioning_event_loop,
39 | zclFactoryResetter_loop};
40 |
41 | const uint8 tasksCnt = sizeof(tasksArr) / sizeof(tasksArr[0]);
42 | uint16 *tasksEvents;
43 |
44 | void osalInitTasks(void) {
45 | uint8 taskID = 0;
46 |
47 | tasksEvents = (uint16 *)osal_mem_alloc(sizeof(uint16) * tasksCnt);
48 | osal_memset(tasksEvents, 0, (sizeof(uint16) * tasksCnt));
49 | macTaskInit(taskID++);
50 | nwk_init(taskID++);
51 | Hal_Init(taskID++);
52 | #if defined( MT_TASK )
53 | MT_TaskInit( taskID++ );
54 | #endif
55 | APS_Init(taskID++);
56 | ZDApp_Init(taskID++);
57 | // StubAPS_Init( taskID++ );
58 | // touchLinkTarget_Init( taskID++ );
59 | zcl_Init(taskID++);
60 | bdb_Init(taskID++);
61 | zclApp_Init(taskID++);
62 | zclCommissioning_Init(taskID++);
63 | zclFactoryResetter_Init(taskID++);
64 | }
65 |
66 | /*********************************************************************
67 | *********************************************************************/
68 |
--------------------------------------------------------------------------------
/README_ru.md:
--------------------------------------------------------------------------------
1 |
2 | -------------------------
3 | Индикатор радиоактивности Zigbee
4 |
5 | https://modkam.ru/?p=1591
6 |
7 | https://github.com/diyruz/geiger
8 | -------------------------
9 |
10 |
11 | Сброс устройства для подключения к сети:
12 | - Обесточить устройство (лучше всего кабель от источника питания отключать).
13 | - Подать питание и дождаться, пока не загорится светодиод, тут же питание отключить на секунду и подать вновь.
14 | - Повторить цикл подачи питания 5 раз.
15 | - Через некоторое время устройство начнет сопряжение с сетью ZigBee (на координаторе также нужно включить режим сопряжения).
16 |
17 | -------------------------
18 |
19 | Настройки:
20 |
21 | # Тип трубки (0: СБМ-20/СТС-5/BOI-33; 1: СБМ-19/СТС-6; 3: все остальное):
22 | mosquitto_pub -h mqtt_server -u mqtt_user -P mqtt_password -t 'zigbee2mqtt/0x00124b001ec7777e/1/set/sensors_type' -m '0' -d
23 |
24 | # Кол-во трубок:
25 | mosquitto_pub -h mqtt_server -u mqtt_user -P mqtt_password -t 'zigbee2mqtt/0x00124b001ec7777e/1/set/sensors_count' -m '2' -d
26 | # Когда трубки две - показания меньше плавают, чем с одной. Но, мне кажется, показания несколько завышаются при этом.
27 |
28 | # Число милирентген для аларма:
29 | mosquitto_pub -h mqtt_server -u mqtt_user -P mqtt_password -t 'zigbee2mqtt/0x00124b001ec7777e/1/set/alert_threshold' -m '60' -d
30 |
31 | # Мигание диодом на события радиации:
32 | mosquitto_pub -h mqtt_server -u mqtt_user -P mqtt_password -t 'zigbee2mqtt/0x00124b001ec7777e/1/set/led_feedback' -m 'ON' -d
33 |
34 | # НЕ ПОДДЕРДИВАЕТСЯ: Пищание на события радиации:
35 |
36 | mosquitto_pub -h mqtt_server -u mqtt_user -P mqtt_password -t 'zigbee2mqtt/0x00124b001ec7777e/1/set/buzzer_feedback' -m 'ON' -d
37 |
38 | # Удаление из сети:
39 | mosquitto_pub -h mqtt_server -u mqtt_user -P mqtt_password -t 'zigbee2mqtt/bridge/config/remove' -m '0x00124b001ec7777e' -d
40 |
41 | 0x00124b001ec7777e - адрес или friendly name индикатора радиоактивности, поменять на свое значение
42 |
43 | Не проверял:
44 | Sensitivity: mosquitto_pub -t "zigbee2mqtt/FN/BUTTON_NUM/set/sensitivity" -m '100' This attribute will be used on reporting, pulsesCount * sensitivity. You can use this attribute to setup reporting in your prefered units radiationDosePerHour = pulsesCount * sensitivity
45 |
46 | -------------------------
47 |
48 | alert_threshold — выставляем уровень в мкР/ч при превышении которого сработает сигнализация
49 |
50 | buzzer — встроенный зуммер (поддержка пока не реализована)
51 |
52 | Led — включаем/выключаем светодиод отображающий регистрацию частиц
53 |
54 | rph — регистрируемое значение в мкР/ч
55 |
56 | rpm — регистрируемое значение частиц в минуту
57 |
58 | sensitivity — чувствительность счетчика (используется если выбран пункт 3 в sensor_type)
59 |
60 | sensor_type — выбор типа счетчика:
61 |
62 | 0) СБМ-20/СТС-5/BOI-33
63 | 1) СБМ-19/СТС-6
64 | 3) все остальное
65 |
66 | sensors_count — количество установленных счетчиков
67 |
68 |
69 |
--------------------------------------------------------------------------------
/CC2530DB/settings/GenericApp.dnx:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | 0
5 | 1
6 | 90
7 | 1
8 | 1
9 | 1
10 | main
11 | 0
12 | 50
13 |
14 |
15 | _ 1238 679 2122 1219
16 |
17 |
18 | 1012864217
19 |
20 |
21 | 0
22 |
23 |
24 | 1
25 |
26 |
27 | 0
28 |
29 |
30 | 0
31 | 1
32 |
33 |
34 | _ 0
35 |
36 |
37 | 0
38 | 1
39 | 0
40 | 0
41 |
42 |
43 |
44 | 0
45 |
46 |
47 | 1
48 |
49 |
50 | _ 0
51 | _ ""
52 | _ 0
53 |
54 |
55 | _ 0
56 | _ ""
57 |
58 |
59 | 0
60 | 0
61 | 1
62 | 0
63 | 1
64 | 0
65 |
66 |
67 | 0
68 | 0
69 | 1
70 | 0
71 | 1
72 |
73 |
74 | _ 0 "STD_CODE2" "{$PROJ_DIR$\..\Source\zcl_app_data.c}.1.1" 0 0 1 "" 0 ""
75 | 1
76 |
77 |
78 | 1
79 |
80 |
81 | 0
82 | 0
83 | 0
84 | 1
85 | 1
86 | 1
87 |
88 |
89 | 0
90 | 1
91 |
92 |
93 | 0
94 | 0
95 |
96 |
97 | 50000000
98 | 0
99 |
100 |
101 |
--------------------------------------------------------------------------------
/Source/zcl_app.h:
--------------------------------------------------------------------------------
1 | #ifndef ZCL_APP_H
2 | #define ZCL_APP_H
3 |
4 | #ifdef __cplusplus
5 | extern "C" {
6 | #endif
7 |
8 | /*********************************************************************
9 | * INCLUDES
10 | */
11 | #include "version.h"
12 | #include "zcl.h"
13 |
14 | /*********************************************************************
15 | * CONSTANTS
16 | */
17 | #define APP_REPORT_DELAY ((uint32)60 * (uint32)1000) // 1 minute
18 | // Application Events
19 | #define APP_REPORT_EVT 0x0001
20 | #define APP_SAVE_ATTRS_EVT 0x0002
21 |
22 | /*********************************************************************
23 | * MACROS
24 | */
25 |
26 | #define NW_APP_CONFIG 0x0401
27 |
28 | #define R ACCESS_CONTROL_READ
29 | //ACCESS_CONTROL_AUTH_WRITE
30 | #define RW (R | ACCESS_CONTROL_WRITE | ACCESS_CONTROL_AUTH_WRITE)
31 | #define RR (R | ACCESS_REPORTABLE)
32 |
33 | #define BASIC ZCL_CLUSTER_ID_GEN_BASIC
34 | #define GEN_ON_OFF ZCL_CLUSTER_ID_GEN_ON_OFF
35 | #define POWER_CFG ZCL_CLUSTER_ID_GEN_ON
36 | #define ILLUMINANCE ZCL_CLUSTER_ID_MS_ILLUMINANCE_MEASUREMENT
37 | #define ILLUMINANCE_CONFIG ZCL_CLUSTER_ID_MS_ILLUMINANCE_LEVEL_SENSING_CONFIG
38 |
39 |
40 | #define ATTRID_RADIATION_SENSOR_SENSIVITY 0xF000
41 | #define ATTRID_RADIATION_LED_FEEDBACK 0xF001
42 | #define ATTRID_RADIATION_BUZZER_FEEDBACK 0xF002
43 | #define ATTRID_RADIATION_SENSORS_COUNT 0xF003
44 | #define ATTRID_RADIATION_SENSORS_TYPE 0xF004
45 | #define ATTRID_RADIATION_ALERT_TRESHOLD 0xF005
46 |
47 | #define ATTRID_RADIATION_EVENTS_PER_MINUTE 0xF001
48 | #define ATTRID_RADIATION_LEVEL_PER_HOUR 0xF002
49 |
50 |
51 | #define ZCL_UINT8 ZCL_DATATYPE_UINT8
52 | #define ZCL_UINT16 ZCL_DATATYPE_UINT16
53 | #define ZCL_UINT32 ZCL_DATATYPE_UINT32
54 | /*********************************************************************
55 | * TYPEDEFS
56 | */
57 | typedef enum {
58 | SBM_20, // СБМ-20/СТС-5/BOI-33
59 | SBM_19 // СБМ-19/СТС-6
60 | } RadiationSensorType_t;
61 |
62 | typedef struct
63 | {
64 | uint16 SensorSensivity;
65 | uint32 AlertTreshold;
66 | uint8 LedFeedback;
67 | uint8 BuzzerFeedback;
68 | uint8 SensorsCount;
69 | RadiationSensorType_t SensorType;
70 | } application_config_t;
71 |
72 | /*********************************************************************
73 | * VARIABLES
74 | */
75 |
76 | extern SimpleDescriptionFormat_t zclApp_FirstEP;
77 | extern CONST zclAttrRec_t zclApp_AttrsFirstEP[];
78 | extern CONST uint8 zclApp_AttrsCount;
79 |
80 | extern const uint8 zclApp_ManufacturerName[];
81 | extern const uint8 zclApp_ModelId[];
82 | extern const uint8 zclApp_PowerSource;
83 | extern uint16 zclApp_RadiationEventsPerMinute;
84 | extern uint32 zclApp_RadiationLevelParrotsPerHour;
85 | extern application_config_t zclApp_Config;
86 |
87 | // APP_TODO: Declare application specific attributes here
88 |
89 | /*********************************************************************
90 | * FUNCTIONS
91 | */
92 |
93 | /*
94 | * Initialization for the task
95 | */
96 | extern void zclApp_Init(byte task_id);
97 |
98 | /*
99 | * Event Process for the task
100 | */
101 | extern UINT16 zclApp_event_loop(byte task_id, UINT16 events);
102 |
103 | extern void zclApp_ResetAttributesToDefaultValues(void);
104 |
105 | /*********************************************************************
106 | *********************************************************************/
107 |
108 | #ifdef __cplusplus
109 | }
110 | #endif
111 |
112 | #endif /* ZCL_APP_H */
113 |
--------------------------------------------------------------------------------
/Source/isr_counter.c:
--------------------------------------------------------------------------------
1 | #include "isr_counter.h"
2 | #include "Debug.h"
3 |
4 | #if defined(HAL_BOARD_TARGET)
5 | #define ISR_COUNTER_P0_PINS (BV(4))
6 | #elif defined(HAL_BOARD_CHDTECH_DEV)
7 | #define ISR_COUNTER_P0_PINS (BV(1) | BV(4))
8 | #endif
9 |
10 | // #define ISR_COUNTER_P1_PINS 0x00
11 | // #define ISR_COUNTER_P2_PINS 0x00
12 |
13 | #define ISR_COUNTER_RISING_EDGE 0
14 | #define ISR_COUNTER_FALLING_EDGE 1
15 |
16 | #define ISR_COUNTER_P0_EDGE ISR_COUNTER_FALLING_EDGE
17 | #define ISR_COUNTER_P1_EDGE ISR_COUNTER_FALLING_EDGE
18 | #define ISR_COUNTER_P2_EDGE ISR_COUNTER_FALLING_EDGE
19 |
20 | #define UINT32_MAX 4294967295U
21 | isr_counter_CB_t zclApp_PortCounterCB = NULL;
22 |
23 | void zclApp_RegisterCounterCallback(isr_counter_CB_t callback) { zclApp_PortCounterCB = callback; }
24 |
25 | #ifdef ISR_COUNTER_P0_PINS
26 | uint16 zclApp_Port0CounterValue = 0;
27 | #endif
28 |
29 | #ifdef ISR_COUNTER_P1_PINS
30 | uint16 zclApp_Port1CounterValue = 0;
31 | #endif
32 |
33 | #ifdef ISR_COUNTER_P2_PINS
34 | uint16 zclApp_Port2CounterValue = 0;
35 | #endif
36 |
37 | void zclApp_InitCounter(void) {
38 | #ifdef ISR_COUNTER_P0_PINS
39 | P0SEL &= ~ISR_COUNTER_P0_PINS;
40 | P0DIR &= ~(ISR_COUNTER_P0_PINS);
41 | #if ISR_COUNTER_P0_EDGE == ISR_COUNTER_RISING_EDGE
42 | PICTL &= ~BV(0); // Rising edge on input gives interrupt.
43 | #else
44 | PICTL |= BV(0); // Falling edge on input gives interrupt
45 | #endif
46 | P0IEN |= ISR_COUNTER_P0_PINS;
47 |
48 | IEN1 |= BV(5);
49 | #endif
50 |
51 | #ifdef ISR_COUNTER_P1_PINS
52 | P1SEL &= ~ISR_COUNTER_P1_PINS;
53 | P1DIR &= ~(ISR_COUNTER_P1_PINS);
54 | #if ISR_COUNTER_P1_EDGE == ISR_COUNTER_RISING_EDGE
55 | PICTL &= ~BV(1); // Port 1, inputs 3 to 0 interrupt configuration.
56 | PICTL &= ~BV(2); // Port 1, inputs 7 to 4 interrupt configuration.
57 | #else
58 | PICTL |= BV(1); // Port 1, inputs 3 to 0 interrupt configuration.
59 | PICTL |= BV(2); // Port 1, inputs 7 to 4 interrupt configuration.
60 | #endif
61 | P1IEN |= ISR_COUNTER_P1_PINS;
62 | IEN2 |= BV(4);
63 | #endif
64 |
65 | #ifdef ISR_COUNTER_P2_PINS
66 | P2SEL &= ~ISR_COUNTER_P2_PINS;
67 | P2DIR &= ~(ISR_COUNTER_P2_PINS);
68 | #if ISR_COUNTER_P2_EDGE == ISR_COUNTER_RISING_EDGE
69 | PICTL &= ~BV(3); // Port 2, inputs 4 to 0 interrupt configuration.
70 | #else
71 | PICTL |= BV(3); // Port 2, inputs 4 to 0 interrupt configuration.
72 | #endif
73 | P2IEN |= ISR_COUNTER_P2_PINS;
74 | IEN2 |= BV(1);
75 | #endif
76 | }
77 |
78 | #ifdef ISR_COUNTER_P0_PINS
79 | HAL_ISR_FUNCTION(halKeyPort0Isr, P0INT_VECTOR) {
80 | HAL_ENTER_ISR();
81 |
82 | if (P0IFG & ISR_COUNTER_P0_PINS) {
83 | // if (zclApp_Port0CounterValue >= UINT32_MAX) { //should be dead already
84 | // zclApp_Port0CounterValue = 0;
85 | // }
86 | zclApp_Port0CounterValue += 1;
87 | P0IFG &= ~ISR_COUNTER_P0_PINS;
88 | if (zclApp_PortCounterCB != NULL) {
89 | (*zclApp_PortCounterCB)(0);
90 | }
91 | }
92 | P0IF = 0;
93 |
94 | HAL_EXIT_ISR();
95 | }
96 | #endif
97 |
98 | #ifdef ISR_COUNTER_P1_PINS
99 | HAL_ISR_FUNCTION(halKeyPort1Isr, P1INT_VECTOR) {
100 | HAL_ENTER_ISR();
101 |
102 | if (P1IFG & ISR_COUNTER_P1_PINS) {
103 | zclApp_Port1CounterValue += 1;
104 | P1IFG &= ~ISR_COUNTER_P1_PINS;
105 | if (zclApp_PortCounterCB != NULL) {
106 | (*zclApp_PortCounterCB)(1);
107 | }
108 | }
109 |
110 | P1IF = 0;
111 |
112 | HAL_EXIT_ISR();
113 | }
114 | #endif
115 |
116 | #ifdef ISR_COUNTER_P2_PINS
117 | HAL_ISR_FUNCTION(halKeyPort2Isr, P2INT_VECTOR) {
118 | HAL_ENTER_ISR();
119 |
120 | if (P2IFG & ISR_COUNTER_P2_PINS) {
121 | zclApp_Port2CounterValue += 1;
122 | P2IFG &= ~ISR_COUNTER_P2_PINS;
123 | if (zclApp_PortCounterCB != NULL) {
124 | (*zclApp_PortCounterCB)(2);
125 | }
126 | }
127 |
128 | P2IF = 0;
129 |
130 | HAL_EXIT_ISR();
131 | }
132 | #endif
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | 
2 | We all know what radiation is and its harmful effects on humans. Since this danger is not tangible, in connection with this the idea was born to make an indicator for continuous monitoring of the radiation situation.
3 |
4 | The device is not designed to measure the level of radiation in the epicenter of a nuclear explosion, but it allows you to constantly monitor changes in background values. This can be useful in the event of man-made disasters or when you yourself or others bring something with an increased background radiation into the house. These can be quite harmless-looking things, nevertheless, they carry a direct threat to life and health.
5 |
6 | There are many amateur dosimeter projects, for example one and two.
7 | All of them are built according to almost the same schemes associated with the features of the Geiger counters used. The principle of operation of Geiger counters is based on the effect of impact ionization of a gaseous medium under the action of radioactive particles in the interelectrode space at a high accelerating voltage. Accordingly, the meter requires a high voltage source.
8 |
9 | **ATTENTION! THE DEVICE CONTAINS A HIGH VOLTAGE OF 400 VOLTS**
10 |
11 | Since Jager has a Zigbee network at home, the device will be an element of this network.
12 | The circuit does not contain rare elements and is typical for this type of device.
13 |
14 | ### Diagram
15 | 
16 |
17 | The central elements are the SBM-20 Geiger counter and the E18-MS1PA1-PCB Zigbee module. The scheme includes the ability to use either one or two counters to improve the measurement accuracy.
18 | 
19 |
20 | GAINTA 407 case was selected based on the meter size.
21 | 
22 |
23 | ### PCB
24 | The board was designed by EasyEDA
25 | 
26 |
27 | 
28 |
29 | Production at JLCPCB
30 | 
31 |
32 | 
33 |
34 | The general assembly has no peculiarities, the smallest SMD elements are 0805. The capacitors in the voltage multiplier are 600 volts and are 1206 in size. There is a trimmer resistor on the board to set the high voltage level.
35 | 
36 |
37 | There is a peculiarity in sealing the meter holders, since the width of the case does not allow placing two meters and the micro USB connector at a sufficient distance from each other, the holders must be raised above the board. When soldering, use any 0.8-1.0 mm spacer
38 | 
39 |
40 | Physically, you can install counters 90 or 107 mm long.
41 | Such as Soviet SBM-20 and SBM-19 or Chinese J305 and M4011.
42 |
43 | To revive the device @anonymass wrote an open source firmware. The firmware implements support for several counters, displaying the number of registered particles per minute with the conversion of these values to the usual μR / h. An important feature is the ability to set the level at which the alarm is triggered. This condition can be tied to the triggering of a physical siren or light bulb as a means of control and using direct binding on the Zigbee device, which will enable notification even if the Zigbee network is not available.
44 |
45 | If the board is correctly assembled, after downloading the firmware, it will be possible to "see" the registered particles immediately
46 | [](https://www.youtube.com/watch?v=Ee7PnegF638)
47 |
48 | ### Support
49 | Device support is implemented in zigbee2mqtt and SLS Gateway
50 |
51 | 
52 | 
53 |
54 | 
55 | 
56 |
57 | ### Settings
58 | * alert_threshold - set the level in μR / h, when exceeded, the alarm will be triggered
59 |
60 | * buzzer - built-in buzzer (not yet supported)
61 |
62 | * Led - turn on / off the LED displaying particle registration
63 | * rph - recorded value in μR / h
64 | * pm - recorded value of particles per minute
65 | * sensitivity - counter sensitivity (used if item 3 is selected in sensor_type)
66 | * sensor_type - select the type of meter:
67 | * SBM-20 / STS-5 / BOI-33
68 | * SBM-19 / STS-6
69 | * everything else
70 |
71 |
72 | * sensors_count - number of installed counters
73 |
74 | The device is also a router in the Zigbee network, which allows you to increase its coverage.
75 | 
76 |
77 | The final assembly includes installing the board into the case and making an end cap with holes for the LED and micro USB connector. These holes can be made in a standard plug, but Jager drew and printed on a 3D printer
78 | 
79 |
80 | 
81 |
82 | That's all, the device is ready to go.
83 |
84 |
85 | In the photos you can see that Jager's counters are damaged, it so happened that Jager got just such. In fact, the damage is much more serious and this can be seen in the photo below, but while maintaining the tightness, they do not affect the operation of the meters.
86 | 
87 |
88 |
89 | ### How to join
90 | * Reset to FN rebooting device 5 times with interval less than 10 seconds, led will start flashing during reset
91 |
92 |
93 | ### Files to reproduce
94 | * [Gerbers and BOM and STL](https://github.com/diyruz/geiger/tree/master/hardware) by [Jager](https://t.me/Jager_f)
95 | * [Firmware](https://github.com/diyruz/geiger/releases) by [@anonymass](https://t.me/anonymass)
96 |
97 |
98 | [Original post by Jager](https://modkam.ru/?p=1591)
99 |
--------------------------------------------------------------------------------
/Source/zcl_app_data.c:
--------------------------------------------------------------------------------
1 | #include "AF.h"
2 | #include "OSAL.h"
3 | #include "ZComDef.h"
4 | #include "ZDConfig.h"
5 |
6 | #include "zcl.h"
7 | #include "zcl_general.h"
8 | #include "zcl_ha.h"
9 | #include "zcl_ms.h"
10 |
11 | #include "zcl_app.h"
12 |
13 | #include "version.h"
14 |
15 | #include "bdb_touchlink.h"
16 | #include "bdb_touchlink_target.h"
17 | #include "stub_aps.h"
18 |
19 | /*********************************************************************
20 | * CONSTANTS
21 | */
22 |
23 | #define APP_DEVICE_VERSION 2
24 | #define APP_FLAGS 0
25 |
26 | #define APP_HWVERSION 1
27 | #define APP_ZCLVERSION 1
28 |
29 | /*********************************************************************
30 | * TYPEDEFS
31 | */
32 |
33 | /*********************************************************************
34 | * MACROS
35 | */
36 |
37 | /*********************************************************************
38 | * GLOBAL VARIABLES
39 | */
40 |
41 | // Global attributes
42 | const uint16 zclApp_clusterRevision_all = 0x0001;
43 |
44 | // Basic Cluster
45 | const uint8 zclApp_HWRevision = APP_HWVERSION;
46 | const uint8 zclApp_ZCLVersion = APP_ZCLVERSION;
47 | const uint8 zclApp_ApplicationVersion = 2;
48 | const uint8 zclApp_StackVersion = 4;
49 |
50 | //{lenght, 'd', 'a', 't', 'a'}
51 | const uint8 zclApp_ManufacturerName[] = {9, 'm', 'o', 'd', 'k', 'a', 'm', '.', 'r', 'u'};
52 | const uint8 zclApp_ModelId[] = {13, 'D', 'I', 'Y', 'R', 'u', 'Z', '_', 'G', 'e', 'i', 'g', 'e', 'r'};
53 | const uint8 zclApp_PowerSource = POWER_SOURCE_MAINS_1_PHASE;
54 |
55 | #define DEFAULT_SensorSensivity 65
56 | #define DEFAULT_AlertTreshold 100
57 | #define DEFAULT_LedFeedback TRUE
58 | #define DEFAULT_BuzzerFeedback FALSE
59 | #define DEFAULT_SensorsCount 1
60 | #define DEFAULT_SensorType SBM_20
61 |
62 | application_config_t zclApp_Config = {.SensorSensivity = DEFAULT_SensorSensivity,
63 | .AlertTreshold = DEFAULT_AlertTreshold,
64 | .LedFeedback = DEFAULT_LedFeedback,
65 | .BuzzerFeedback = DEFAULT_BuzzerFeedback,
66 | .SensorsCount = DEFAULT_SensorsCount,
67 | .SensorType = DEFAULT_SensorType};
68 |
69 | uint16 zclApp_RadiationEventsPerMinute = 0; // pulses per minute
70 | uint32 zclApp_RadiationLevelParrotsPerHour = 0; // parrots per hour
71 |
72 | /*********************************************************************
73 | * ATTRIBUTE DEFINITIONS - Uses REAL cluster IDs
74 | */
75 |
76 | CONST zclAttrRec_t zclApp_AttrsFirstEP[] = {
77 | {BASIC, {ATTRID_BASIC_ZCL_VERSION, ZCL_UINT8, R, (void *)&zclApp_ZCLVersion}},
78 | {BASIC, {ATTRID_BASIC_APPL_VERSION, ZCL_UINT8, R, (void *)&zclApp_ApplicationVersion}},
79 | {BASIC, {ATTRID_BASIC_STACK_VERSION, ZCL_UINT8, R, (void *)&zclApp_StackVersion}},
80 | {BASIC, {ATTRID_BASIC_HW_VERSION, ZCL_UINT8, R, (void *)&zclApp_HWRevision}},
81 | {BASIC, {ATTRID_BASIC_MANUFACTURER_NAME, ZCL_DATATYPE_CHAR_STR, R, (void *)zclApp_ManufacturerName}},
82 | {BASIC, {ATTRID_BASIC_MODEL_ID, ZCL_DATATYPE_CHAR_STR, R, (void *)zclApp_ModelId}},
83 | {BASIC, {ATTRID_BASIC_DATE_CODE, ZCL_DATATYPE_CHAR_STR, R, (void *)zclApp_DateCode}},
84 | {BASIC, {ATTRID_BASIC_POWER_SOURCE, ZCL_DATATYPE_ENUM8, R, (void *)&zclApp_PowerSource}},
85 | {BASIC, {ATTRID_BASIC_SW_BUILD_ID, ZCL_UINT8, R, (void *)&zclApp_ApplicationVersion}},
86 | {BASIC, {ATTRID_CLUSTER_REVISION, ZCL_UINT16, R, (void *)&zclApp_clusterRevision_all}},
87 |
88 | {ILLUMINANCE, {ATTRID_RADIATION_EVENTS_PER_MINUTE, ZCL_UINT16, RR, (void *)&zclApp_RadiationEventsPerMinute}},
89 | {ILLUMINANCE, {ATTRID_RADIATION_LEVEL_PER_HOUR, ZCL_UINT32, RR, (void *)&zclApp_RadiationLevelParrotsPerHour}},
90 |
91 | {ILLUMINANCE_CONFIG, {ATTRID_RADIATION_SENSOR_SENSIVITY, ZCL_UINT16, RW, (void *)&zclApp_Config.SensorSensivity}},
92 | {ILLUMINANCE_CONFIG, {ATTRID_RADIATION_LED_FEEDBACK, ZCL_DATATYPE_BOOLEAN, RW, (void *)&zclApp_Config.LedFeedback}},
93 | {ILLUMINANCE_CONFIG, {ATTRID_RADIATION_BUZZER_FEEDBACK, ZCL_DATATYPE_BOOLEAN, RW, (void *)&zclApp_Config.BuzzerFeedback}},
94 | {ILLUMINANCE_CONFIG, {ATTRID_RADIATION_SENSORS_COUNT, ZCL_UINT8, RW, (void *)&zclApp_Config.SensorsCount}},
95 | {ILLUMINANCE_CONFIG, {ATTRID_RADIATION_SENSORS_TYPE, ZCL_DATATYPE_ENUM8, RW, (void *)&zclApp_Config.SensorType}},
96 | {ILLUMINANCE_CONFIG, {ATTRID_RADIATION_ALERT_TRESHOLD, ZCL_UINT32, RW, (void *)&zclApp_Config.AlertTreshold}},
97 | };
98 |
99 | uint8 CONST zclApp_AttrsCount = (sizeof(zclApp_AttrsFirstEP) / sizeof(zclApp_AttrsFirstEP[0]));
100 |
101 | const cId_t zclApp_InClusterList[] = {ZCL_CLUSTER_ID_GEN_BASIC};
102 |
103 | #define APP_MAX_INCLUSTERS (sizeof(zclApp_InClusterList) / sizeof(zclApp_InClusterList[0]))
104 |
105 | const cId_t zclApp_OutClusterList[] = {ILLUMINANCE, GEN_ON_OFF};
106 |
107 | #define APP_MAX_OUT_CLUSTERS (sizeof(zclApp_OutClusterList) / sizeof(zclApp_OutClusterList[0]))
108 |
109 | SimpleDescriptionFormat_t zclApp_FirstEP = {
110 | 1, // int Endpoint;
111 | ZCL_HA_PROFILE_ID, // uint16 AppProfId[2];
112 | ZCL_HA_DEVICEID_SIMPLE_SENSOR, // uint16 AppDeviceId[2];
113 | APP_DEVICE_VERSION, // int AppDevVer:4;
114 | APP_FLAGS, // int AppFlags:4;
115 | APP_MAX_INCLUSTERS, // byte AppNumInClusters;
116 | (cId_t *)zclApp_InClusterList, // byte *pAppInClusterList;
117 | APP_MAX_OUT_CLUSTERS, // byte AppNumInClusters;
118 | (cId_t *)zclApp_OutClusterList // byte *pAppInClusterList;
119 | };
120 |
121 | void zclApp_ResetAttributesToDefaultValues(void) {
122 |
123 | zclApp_Config.SensorSensivity = DEFAULT_SensorSensivity;
124 | zclApp_Config.AlertTreshold = DEFAULT_AlertTreshold;
125 | zclApp_Config.LedFeedback = DEFAULT_LedFeedback;
126 | zclApp_Config.BuzzerFeedback = DEFAULT_BuzzerFeedback;
127 | zclApp_Config.SensorsCount = DEFAULT_SensorsCount;
128 | zclApp_Config.SensorType = DEFAULT_SensorType;
129 | }
--------------------------------------------------------------------------------
/Source/zcl_app.c:
--------------------------------------------------------------------------------
1 |
2 | #include "AF.h"
3 | #include "OSAL.h"
4 | #include "OSAL_Clock.h"
5 | #include "OSAL_PwrMgr.h"
6 | #include "ZComDef.h"
7 | #include "ZDApp.h"
8 | #include "ZDObject.h"
9 | #include "math.h"
10 |
11 | #include "nwk_util.h"
12 | #include "zcl.h"
13 | #include "zcl_app.h"
14 | #include "zcl_diagnostic.h"
15 | #include "zcl_general.h"
16 | #include "zcl_lighting.h"
17 | #include "zcl_ms.h"
18 |
19 | #include "bdb.h"
20 | #include "bdb_interface.h"
21 | #include "bdb_touchlink.h"
22 | #include "bdb_touchlink_target.h"
23 |
24 | #include "gp_interface.h"
25 |
26 | #include "Debug.h"
27 |
28 | #include "onboard.h"
29 |
30 | /* HAL */
31 | #include "hal_drivers.h"
32 | #include "hal_key.h"
33 | #include "hal_led.h"
34 | #include "isr_counter.h"
35 |
36 | #include "version.h"
37 |
38 | #include "calculate_urh.h"
39 |
40 | #include "DebugTrace.h"
41 | /*********************************************************************
42 | * MACROS
43 | */
44 |
45 | /*********************************************************************
46 | * CONSTANTS
47 | */
48 |
49 | /*********************************************************************
50 | * TYPEDEFS
51 | */
52 |
53 | /*********************************************************************
54 | * GLOBAL VARIABLES
55 | */
56 |
57 | extern bool requestNewTrustCenterLinkKey;
58 | byte zclApp_TaskID;
59 |
60 | /*********************************************************************
61 | * GLOBAL FUNCTIONS
62 | */
63 |
64 | /*********************************************************************
65 | * LOCAL VARIABLES
66 | */
67 |
68 | /*********************************************************************
69 | * LOCAL FUNCTIONS
70 | */
71 |
72 | static void zclApp_Report(void);
73 | static void zclApp_BasicResetCB(void);
74 | static void zclApp_RestoreAttributesFromNV(void);
75 | static void zclApp_SaveAttributesToNV(void);
76 |
77 | static ZStatus_t zclApp_ReadWriteAuthCB(afAddrType_t *srcAddr, zclAttrRec_t *pAttr, uint8 oper);
78 | static void zclApp_RadioactiveEventCB(uint8 portNum);
79 |
80 | /*********************************************************************
81 | * ZCL General Profile Callback table
82 | */
83 | static zclGeneral_AppCallbacks_t zclApp_CmdCallbacks = {
84 | zclApp_BasicResetCB, // Basic Cluster Reset command
85 | NULL, // Identify Trigger Effect command
86 | NULL, // On/Off cluster commands
87 | NULL, // On/Off cluster enhanced command Off with Effect
88 | NULL, // On/Off cluster enhanced command On with Recall Global Scene
89 | NULL, // On/Off cluster enhanced command On with Timed Off
90 | NULL, // RSSI Location command
91 | NULL // RSSI Location Response command
92 | };
93 | void zclApp_Init(byte task_id) {
94 | // debug_str("Hello \r\n");
95 | DebugInit();
96 | zclApp_RestoreAttributesFromNV();
97 | LREP("Sensivity %d led %d buzzer %d \r\n", zclApp_Config.SensorSensivity, zclApp_Config.LedFeedback, zclApp_Config.BuzzerFeedback);
98 | // this is important to allow connects throught routers
99 | // to make this work, coordinator should be compiled with this flag #define TP2_LEGACY_ZC
100 | requestNewTrustCenterLinkKey = FALSE;
101 |
102 | zclApp_TaskID = task_id;
103 |
104 | bdb_RegisterSimpleDescriptor(&zclApp_FirstEP);
105 | zclGeneral_RegisterCmdCallbacks(zclApp_FirstEP.EndPoint, &zclApp_CmdCallbacks);
106 |
107 | zcl_registerAttrList(zclApp_FirstEP.EndPoint, zclApp_AttrsCount, zclApp_AttrsFirstEP);
108 |
109 | zcl_registerReadWriteCB(zclApp_FirstEP.EndPoint, NULL, zclApp_ReadWriteAuthCB);
110 | zcl_registerForMsg(zclApp_TaskID);
111 |
112 | ZMacSetTransmitPower(APP_TX_POWER);
113 |
114 | LREP("Build %s \r\n", zclApp_DateCodeNT);
115 |
116 | zclApp_InitCounter();
117 | zclApp_RegisterCounterCallback(zclApp_RadioactiveEventCB);
118 | osal_start_reload_timer(zclApp_TaskID, APP_REPORT_EVT, APP_REPORT_DELAY);
119 | }
120 |
121 | uint16 zclApp_event_loop(uint8 task_id, uint16 events) {
122 | LREP("events 0x%x \r\n", events);
123 | if (events & SYS_EVENT_MSG) {
124 | afIncomingMSGPacket_t *MSGpkt;
125 | while ((MSGpkt = (afIncomingMSGPacket_t *)osal_msg_receive(zclApp_TaskID))) {
126 | LREP("MSGpkt->hdr.event 0x%X clusterId=0x%X\r\n", MSGpkt->hdr.event, MSGpkt->clusterId);
127 | switch (MSGpkt->hdr.event) {
128 | case ZCL_INCOMING_MSG:
129 | if (((zclIncomingMsg_t *)MSGpkt)->attrCmd) {
130 | osal_mem_free(((zclIncomingMsg_t *)MSGpkt)->attrCmd);
131 | }
132 | break;
133 |
134 | default:
135 | break;
136 | }
137 |
138 | // Release the memory
139 | osal_msg_deallocate((uint8 *)MSGpkt);
140 | }
141 | // return unprocessed events
142 | return (events ^ SYS_EVENT_MSG);
143 | }
144 | if (events & APP_REPORT_EVT) {
145 | LREPMaster("APP_REPORT_EVT\r\n");
146 | zclApp_Report();
147 | return (events ^ APP_REPORT_EVT);
148 | }
149 |
150 | if (events & APP_SAVE_ATTRS_EVT) {
151 | LREPMaster("APP_SAVE_ATTRS_EVT\r\n");
152 | zclApp_SaveAttributesToNV();
153 | return (events ^ APP_SAVE_ATTRS_EVT);
154 | }
155 | return 0;
156 | }
157 |
158 | bool lastAlertStatus = FALSE;
159 |
160 | static void zclApp_Report(void) {
161 | halIntState_t intState;
162 |
163 | HAL_ENTER_CRITICAL_SECTION(intState);
164 | zclApp_RadiationEventsPerMinute = zclApp_Port0CounterValue;
165 | zclApp_Port0CounterValue = 0;
166 | HAL_EXIT_CRITICAL_SECTION(intState);
167 |
168 | float countsPerSecond = zclApp_RadiationEventsPerMinute / 60.0 / zclApp_Config.SensorsCount;
169 |
170 | switch (zclApp_Config.SensorType) {
171 | case SBM_19:
172 | zclApp_RadiationLevelParrotsPerHour = calculate_urh_sbm19(countsPerSecond);
173 | break;
174 |
175 | case SBM_20:
176 | zclApp_RadiationLevelParrotsPerHour = calculate_urh_sbm20(countsPerSecond);
177 | break;
178 |
179 | // TODO: Add other sensors here
180 |
181 | default:
182 | zclApp_RadiationLevelParrotsPerHour = (uint32)(countsPerSecond * zclApp_Config.SensorSensivity);
183 | break;
184 | }
185 | bool alertStatus = zclApp_RadiationLevelParrotsPerHour > zclApp_Config.AlertTreshold;
186 | afAddrType_t inderect_DstAddr = {.addrMode = (afAddrMode_t)AddrNotPresent, .endPoint = 0, .addr.shortAddr = 0};
187 | LREP("AlertTreshold=%ld radiationLevel=%ld\r\n", zclApp_Config.AlertTreshold, zclApp_RadiationLevelParrotsPerHour);
188 | LREP("alertStatus=%d lastAlertStatus=%d\r\n", alertStatus, lastAlertStatus);
189 |
190 | if (alertStatus != lastAlertStatus) {
191 | if (alertStatus) {
192 | zclGeneral_SendOnOff_CmdOn(zclApp_FirstEP.EndPoint, &inderect_DstAddr, FALSE, bdb_getZCLFrameCounter());
193 | } else {
194 | zclGeneral_SendOnOff_CmdOff(zclApp_FirstEP.EndPoint, &inderect_DstAddr, FALSE, bdb_getZCLFrameCounter());
195 | }
196 | lastAlertStatus = alertStatus;
197 | }
198 |
199 | LREP("RadiationEventsPerMinute=%d \r\n", zclApp_RadiationEventsPerMinute);
200 | LREP("s_type=%d s_count=%d radiation(mR/h)=%ld\r\n", zclApp_Config.SensorType, zclApp_Config.SensorsCount, zclApp_RadiationLevelParrotsPerHour);
201 |
202 | bdb_RepChangedAttrValue(zclApp_FirstEP.EndPoint, ILLUMINANCE, ATTRID_RADIATION_EVENTS_PER_MINUTE);
203 | }
204 |
205 | static void zclApp_BasicResetCB(void) {
206 | LREPMaster("BasicResetCB\r\n");
207 | zclApp_ResetAttributesToDefaultValues();
208 | zclApp_SaveAttributesToNV();
209 | }
210 |
211 | static ZStatus_t zclApp_ReadWriteAuthCB(afAddrType_t *srcAddr, zclAttrRec_t *pAttr, uint8 oper) {
212 | LREPMaster("AUTH CB called\r\n");
213 |
214 | osal_start_timerEx(zclApp_TaskID, APP_SAVE_ATTRS_EVT, 2000);
215 | return ZSuccess;
216 | }
217 |
218 | static void zclApp_SaveAttributesToNV(void) {
219 | uint8 writeStatus = osal_nv_write(NW_APP_CONFIG, 0, sizeof(application_config_t), &zclApp_Config);
220 | LREP("Saving attributes to NV write=%d\r\n", writeStatus);
221 | }
222 |
223 | static void zclApp_RestoreAttributesFromNV(void) {
224 | uint8 status = osal_nv_item_init(NW_APP_CONFIG, sizeof(application_config_t), NULL);
225 | LREP("Restoring attributes from NV status=%d \r\n", status);
226 | if (status == NV_ITEM_UNINIT) {
227 | uint8 writeStatus = osal_nv_write(NW_APP_CONFIG, 0, sizeof(application_config_t), &zclApp_Config);
228 | LREP("NV was empty, writing %d\r\n", writeStatus);
229 | }
230 | if (status == ZSUCCESS) {
231 | LREPMaster("Reading from NV\r\n");
232 | osal_nv_read(NW_APP_CONFIG, 0, sizeof(application_config_t), &zclApp_Config);
233 | }
234 | }
235 |
236 | void zclApp_RadioactiveEventCB(uint8 portNum) {
237 | LREP("zclApp_RadioactiveEventCB port=%d led=%d buzzer=%d\r\n", portNum, zclApp_Config.LedFeedback, zclApp_Config.BuzzerFeedback);
238 | if (portNum == 0) {
239 | if (zclApp_Config.LedFeedback) {
240 | HalLedSet(HAL_LED_1, HAL_LED_MODE_BLINK);
241 | }
242 |
243 | if (zclApp_Config.BuzzerFeedback) {
244 | // TODO: buzzer feedback
245 | }
246 | }
247 | }
248 | /****************************************************************************
249 | ****************************************************************************/
250 |
--------------------------------------------------------------------------------
/Source/hal_board_cfg.h:
--------------------------------------------------------------------------------
1 | #ifndef HAL_BOARD_CFG_H
2 | #define HAL_BOARD_CFG_H
3 |
4 |
5 | /* ------------------------------------------------------------------------------------------------
6 | * Includes
7 | * ------------------------------------------------------------------------------------------------
8 | */
9 |
10 | #include "hal_mcu.h"
11 | #include "hal_defs.h"
12 | #include "hal_types.h"
13 |
14 | /* ------------------------------------------------------------------------------------------------
15 | * CC2590/CC2591 support
16 | *
17 | * Define HAL_PA_LNA_CC2590 if CC2530+CC2590EM is used
18 | * Define HAL_PA_LNA if CC2530+CC2591EM is used
19 | * Note that only one of them can be defined
20 | * ------------------------------------------------------------------------------------------------
21 | */
22 | #define xHAL_PA_LNA
23 | #define xHAL_PA_LNA_CC2590
24 | #define xHAL_PA_LNA_SE2431L
25 | #define xHAL_PA_LNA_CC2592
26 |
27 | /* ------------------------------------------------------------------------------------------------
28 | * Clock Speed
29 | * ------------------------------------------------------------------------------------------------
30 | */
31 |
32 | #define HAL_CPU_CLOCK_MHZ 32
33 |
34 | /* This flag should be defined if the SoC uses the 32MHz crystal
35 | * as the main clock source (instead of DCO).
36 | */
37 | #define HAL_CLOCK_CRYSTAL
38 |
39 | /* 32 kHz clock source select in CLKCONCMD */
40 | #if !defined (OSC32K_CRYSTAL_INSTALLED) || (defined (OSC32K_CRYSTAL_INSTALLED) && (OSC32K_CRYSTAL_INSTALLED == TRUE))
41 | #define OSC_32KHZ 0x00 /* external 32 KHz xosc */
42 | #else
43 | #define OSC_32KHZ 0x80 /* internal 32 KHz rcosc */
44 | #endif
45 |
46 | #define HAL_CLOCK_STABLE() st( while (CLKCONSTA != (CLKCONCMD_32MHZ | OSC_32KHZ)); )
47 |
48 | /* ------------------------------------------------------------------------------------------------
49 | * LED Configuration
50 | * ------------------------------------------------------------------------------------------------
51 | */
52 |
53 | #if defined (HAL_BOARD_CHDTECH_DEV)
54 | #define HAL_NUM_LEDS 3
55 | #elif defined(HAL_BOARD_TARGET)
56 | #define HAL_NUM_LEDS 1
57 | #else
58 | #error Unknown Board Indentifier
59 | #endif
60 |
61 | #define HAL_LED_BLINK_DELAY() st( { volatile uint32 i; for (i=0; i<0x5800; i++) { }; } )
62 |
63 | #if defined(HAL_BOARD_TARGET)
64 | #define LED1_BV BV(4)
65 | #define LED1_SBIT P1_4
66 | #define LED1_DDR P1DIR
67 | #define LED1_POLARITY ACTIVE_HIGH
68 |
69 | #define LED4_BV BV(4)
70 | #define LED4_SBIT P1_4
71 | #define LED4_DDR P1DIR
72 | #define LED4_POLARITY ACTIVE_HIGH
73 |
74 | #define LED4_BV BV(4)
75 | #define LED4_SBIT P1_4
76 | #define LED4_DDR P1DIR
77 | #define LED4_POLARITY ACTIVE_HIGH
78 |
79 |
80 | #define LED4_BV BV(4)
81 | #define LED4_SBIT P1_4
82 | #define LED4_DDR P1DIR
83 | #define LED4_POLARITY ACTIVE_HIGH
84 |
85 | #elif defined(HAL_BOARD_CHDTECH_DEV)
86 | #define LED1_BV BV(0)
87 | #define LED1_SBIT P1_0
88 | #define LED1_DDR P1DIR
89 | #define LED1_POLARITY ACTIVE_LOW
90 |
91 | #define LED2_BV BV(0)
92 | #define LED2_SBIT P1_0
93 | #define LED2_DDR P1DIR
94 | #define LED2_POLARITY ACTIVE_LOW
95 |
96 | #define LED3_BV BV(4)
97 | #define LED3_SBIT P1_4
98 | #define LED3_DDR P1DIR
99 | #define LED3_POLARITY ACTIVE_LOW
100 |
101 |
102 | #define LED4_BV BV(4)
103 | #define LED4_SBIT P1_4
104 | #define LED4_DDR P1DIR
105 | #define LED4_POLARITY ACTIVE_LOW
106 | #endif
107 |
108 |
109 |
110 | /* ------------------------------------------------------------------------------------------------
111 | * Push Button Configuration
112 | * ------------------------------------------------------------------------------------------------
113 | */
114 |
115 | #define ACTIVE_LOW !
116 | #define ACTIVE_HIGH !! /* double negation forces result to be '1' */
117 |
118 | /* S1 */
119 | #define PUSH1_BV BV(1)
120 | #define PUSH1_SBIT P0_1
121 |
122 |
123 |
124 |
125 | /* ------------------------------------------------------------------------------------------------
126 | * OSAL NV implemented by internal flash pages.
127 | * ------------------------------------------------------------------------------------------------
128 | */
129 |
130 | // Flash is partitioned into 8 banks of 32 KB or 16 pages.
131 | #define HAL_FLASH_PAGE_PER_BANK 16
132 | // Flash is constructed of 128 pages of 2 KB.
133 | #define HAL_FLASH_PAGE_SIZE 2048
134 | #define HAL_FLASH_WORD_SIZE 4
135 |
136 | // CODE banks get mapped into the XDATA range 8000-FFFF.
137 | #define HAL_FLASH_PAGE_MAP 0x8000
138 |
139 | // The last 16 bytes of the last available page are reserved for flash lock bits.
140 | // NV page definitions must coincide with segment declaration in project *.xcl file.
141 | #if defined NON_BANKED
142 | #define HAL_FLASH_LOCK_BITS 16
143 | #define HAL_NV_PAGE_END 30
144 | #define HAL_NV_PAGE_CNT 2
145 | #else
146 | #define HAL_FLASH_LOCK_BITS 16
147 | #define HAL_NV_PAGE_END 126
148 | #define HAL_NV_PAGE_CNT 6
149 | #endif
150 |
151 | // Re-defining Z_EXTADDR_LEN here so as not to include a Z-Stack .h file.
152 | #define HAL_FLASH_IEEE_SIZE 8
153 | #define HAL_FLASH_IEEE_PAGE (HAL_NV_PAGE_END+1)
154 | #define HAL_FLASH_IEEE_OSET (HAL_FLASH_PAGE_SIZE - HAL_FLASH_LOCK_BITS - HAL_FLASH_IEEE_SIZE)
155 | #define HAL_INFOP_IEEE_OSET 0xC
156 |
157 | #define HAL_FLASH_DEV_PRIVATE_KEY_OSET 0x7D2
158 | #define HAL_FLASH_CA_PUBLIC_KEY_OSET 0x7BC
159 | #define HAL_FLASH_IMPLICIT_CERT_OSET 0x78C
160 |
161 | #define HAL_NV_PAGE_BEG (HAL_NV_PAGE_END-HAL_NV_PAGE_CNT+1)
162 | // Used by DMA macros to shift 1 to create a mask for DMA registers.
163 | #define HAL_NV_DMA_CH 0
164 | #define HAL_DMA_CH_RX 3
165 | #define HAL_DMA_CH_TX 4
166 |
167 | #define HAL_NV_DMA_GET_DESC() HAL_DMA_GET_DESC0()
168 | #define HAL_NV_DMA_SET_ADDR(a) HAL_DMA_SET_ADDR_DESC0((a))
169 |
170 | /* ------------------------------------------------------------------------------------------------
171 | * Serial Boot Loader: reserving the first 4 pages of flash and other memory in cc2530-sb.xcl.
172 | * ------------------------------------------------------------------------------------------------
173 | */
174 |
175 | #define HAL_SB_IMG_ADDR 0x2000
176 | #define HAL_SB_CRC_ADDR 0x2090
177 | // Size of internal flash less 4 pages for boot loader, 6 pages for NV, & 1 page for lock bits.
178 | #define HAL_SB_IMG_SIZE (0x40000 - 0x2000 - 0x3000 - 0x0800)
179 |
180 | /* ------------------------------------------------------------------------------------------------
181 | * Macros
182 | * ------------------------------------------------------------------------------------------------
183 | */
184 |
185 | /* ----------- RF-frontend Connection Initialization ---------- */
186 | #if defined HAL_PA_LNA || defined HAL_PA_LNA_CC2590 || \
187 | defined HAL_PA_LNA_SE2431L || defined HAL_PA_LNA_CC2592
188 | extern void MAC_RfFrontendSetup(void);
189 | #define HAL_BOARD_RF_FRONTEND_SETUP() MAC_RfFrontendSetup()
190 | #else
191 | #define HAL_BOARD_RF_FRONTEND_SETUP()
192 | #endif
193 |
194 | /* ----------- Cache Prefetch control ---------- */
195 | #define PREFETCH_ENABLE() st( FCTL = 0x08; )
196 | #define PREFETCH_DISABLE() st( FCTL = 0x04; )
197 |
198 | /* ----------- Board Initialization ---------- */
199 | #if defined (HAL_BOARD_CHDTECH_DEV)
200 | #define HAL_BOARD_INIT() \
201 | { \
202 | uint16 i; \
203 | \
204 | SLEEPCMD &= ~OSC_PD; /* turn on 16MHz RC and 32MHz XOSC */ \
205 | while (!(SLEEPSTA & XOSC_STB)); /* wait for 32MHz XOSC stable */ \
206 | asm("NOP"); /* chip bug workaround */ \
207 | for (i=0; i<504; i++) asm("NOP"); /* Require 63us delay for all revs */ \
208 | CLKCONCMD = (CLKCONCMD_32MHZ | OSC_32KHZ); /* Select 32MHz XOSC and the source for 32K clock */ \
209 | while (CLKCONSTA != (CLKCONCMD_32MHZ | OSC_32KHZ)); /* Wait for the change to be effective */ \
210 | SLEEPCMD |= OSC_PD; /* turn off 16MHz RC */ \
211 | \
212 | /* Turn on cache prefetch mode */ \
213 | PREFETCH_ENABLE(); \
214 | \
215 | LED1_DDR |= LED1_BV; \
216 | LED2_DDR |= LED2_BV; \
217 | LED3_DDR |= LED3_BV; \
218 | }
219 |
220 | #elif defined (HAL_PA_LNA_CC2592) || defined (HAL_PA_LNA_SE2431L)
221 |
222 | #define HAL_BOARD_INIT() \
223 | { \
224 | uint16 i; \
225 | \
226 | SLEEPCMD &= ~OSC_PD; /* turn on 16MHz RC and 32MHz XOSC */ \
227 | while (!(SLEEPSTA & XOSC_STB)); /* wait for 32MHz XOSC stable */ \
228 | asm("NOP"); /* chip bug workaround */ \
229 | for (i=0; i<504; i++) asm("NOP"); /* Require 63us delay for all revs */ \
230 | CLKCONCMD = (CLKCONCMD_32MHZ | OSC_32KHZ); /* Select 32MHz XOSC and the source for 32K clock */ \
231 | while (CLKCONSTA != (CLKCONCMD_32MHZ | OSC_32KHZ)); /* Wait for the change to be effective */ \
232 | SLEEPCMD |= OSC_PD; /* turn off 16MHz RC */ \
233 | \
234 | /* Turn on cache prefetch mode */ \
235 | PREFETCH_ENABLE(); \
236 | \
237 | /* set direction for GPIO outputs */ \
238 | /* For SE2431L PA LNA this sets ANT_SEL to output */ \
239 | /* For CC2592 this enables LNA */ \
240 | P1DIR |= BV(0); \
241 | \
242 | /* Set PA/LNA HGM control P0_7 */ \
243 | P0DIR |= BV(7); \
244 | \
245 | \
246 | /* setup RF frontend if necessary */ \
247 | HAL_BOARD_RF_FRONTEND_SETUP(); \
248 | LED1_DDR |= LED1_BV; \
249 | }
250 | #endif
251 |
252 | /* ----------- Debounce ---------- */
253 | #define HAL_DEBOUNCE(expr) { int i; for (i=0; i<500; i++) { if (!(expr)) i = 0; } }
254 |
255 | /* ----------- Push Buttons ---------- */
256 | #define HAL_PUSH_BUTTON1() (0)
257 | #define HAL_PUSH_BUTTON2() (0)
258 | #define HAL_PUSH_BUTTON3() (0)
259 | #define HAL_PUSH_BUTTON4() (0)
260 | #define HAL_PUSH_BUTTON5() (0)
261 | #define HAL_PUSH_BUTTON6() (0)
262 |
263 | /* ----------- LED's ---------- */
264 | #if defined(HAL_BOARD_CHDTECH_DEV)
265 | #define HAL_TURN_OFF_LED1() st( LED1_SBIT = LED1_POLARITY (0); )
266 | #define HAL_TURN_OFF_LED2() st( LED2_SBIT = LED2_POLARITY (0); )
267 | #define HAL_TURN_OFF_LED3() st( LED3_SBIT = LED3_POLARITY (0); )
268 | #define HAL_TURN_OFF_LED4() st( LED4_SBIT = LED4_POLARITY (0); )
269 |
270 | #define HAL_TURN_ON_LED1() st( LED1_SBIT = LED1_POLARITY (1); )
271 | #define HAL_TURN_ON_LED2() st( LED2_SBIT = LED2_POLARITY (1); )
272 | #define HAL_TURN_ON_LED3() st( LED3_SBIT = LED3_POLARITY (1); )
273 | #define HAL_TURN_ON_LED4() st( LED4_SBIT = LED4_POLARITY (1); )
274 |
275 | #define HAL_TOGGLE_LED1() st( if (LED1_SBIT) { LED1_SBIT = 0; } else { LED1_SBIT = 1;} )
276 | #define HAL_TOGGLE_LED2() st( if (LED2_SBIT) { LED2_SBIT = 0; } else { LED2_SBIT = 1;} )
277 | #define HAL_TOGGLE_LED3() st( if (LED3_SBIT) { LED3_SBIT = 0; } else { LED3_SBIT = 1;} )
278 | #define HAL_TOGGLE_LED4() st( if (LED4_SBIT) { LED4_SBIT = 0; } else { LED4_SBIT = 1;} )
279 |
280 | #define HAL_STATE_LED1() (LED1_POLARITY (LED1_SBIT))
281 | #define HAL_STATE_LED2() (LED2_POLARITY (LED2_SBIT))
282 | #define HAL_STATE_LED3() (LED3_POLARITY (LED3_SBIT))
283 | #define HAL_STATE_LED4() (LED4_POLARITY (LED4_SBIT))
284 | #else
285 | #define HAL_TURN_OFF_LED1() st( LED1_SBIT = LED1_POLARITY (0); )
286 | #define HAL_TURN_OFF_LED2() asm("nop")
287 | #define HAL_TURN_OFF_LED3() asm("nop")
288 | #define HAL_TURN_OFF_LED4() asm("nop")
289 |
290 | #define HAL_TURN_ON_LED1() st( LED1_SBIT = LED1_POLARITY (1); )
291 | #define HAL_TURN_ON_LED2() asm("nop")
292 | #define HAL_TURN_ON_LED3() asm("nop")
293 | #define HAL_TURN_ON_LED4() asm("nop")
294 |
295 | #define HAL_TOGGLE_LED1() st( if (LED1_SBIT) { LED1_SBIT = 0; } else { LED1_SBIT = 1;} )
296 | #define HAL_TOGGLE_LED2() asm("nop")
297 | #define HAL_TOGGLE_LED3() asm("nop")
298 | #define HAL_TOGGLE_LED4() asm("nop")
299 |
300 | #define HAL_STATE_LED1() (LED1_POLARITY (LED1_SBIT))
301 | #define HAL_STATE_LED2() (0)
302 | #define HAL_STATE_LED3() (0)
303 | #define HAL_STATE_LED4() (0)
304 | #endif
305 |
306 | /* ----------- XNV ---------- */
307 | #define XNV_SPI_BEGIN() st(P1_3 = 0;)
308 | #define XNV_SPI_TX(x) st(U1CSR &= ~0x02; U1DBUF = (x);)
309 | #define XNV_SPI_RX() U1DBUF
310 | #define XNV_SPI_WAIT_RXRDY() st(while (!(U1CSR & 0x02));)
311 | #define XNV_SPI_END() st(P1_3 = 1;)
312 |
313 | // The TI reference design uses UART1 Alt. 2 in SPI mode.
314 | #define XNV_SPI_INIT() \
315 | st( \
316 | /* Mode select UART1 SPI Mode as master. */\
317 | U1CSR = 0; \
318 | \
319 | /* Setup for 115200 baud. */\
320 | U1GCR = 11; \
321 | U1BAUD = 216; \
322 | \
323 | /* Set bit order to MSB */\
324 | U1GCR |= BV(5); \
325 | \
326 | /* Set UART1 I/O to alternate 2 location on P1 pins. */\
327 | PERCFG |= 0x02; /* U1CFG */\
328 | \
329 | /* Select peripheral function on I/O pins but SS is left as GPIO for separate control. */\
330 | P1SEL |= 0xE0; /* SELP1_[7:4] */\
331 | /* P1.1,2,3: reset, LCD CS, XNV CS. */\
332 | P1SEL &= ~0x0E; \
333 | P1 |= 0x0E; \
334 | P1_1 = 0; \
335 | P1DIR |= 0x0E; \
336 | \
337 | /* Give UART1 priority over Timer3. */\
338 | P2SEL &= ~0x20; /* PRI2P1 */\
339 | \
340 | /* When SPI config is complete, enable it. */\
341 | U1CSR |= 0x40; \
342 | /* Release XNV reset. */\
343 | P1_1 = 1; \
344 | )
345 |
346 | /* ----------- Minimum safe bus voltage ---------- */
347 |
348 | // Vdd/3 / Internal Reference X ENOB --> (Vdd / 3) / 1.15 X 127
349 | #define VDD_2_0 74 // 2.0 V required to safely read/write internal flash.
350 | #define VDD_2_7 100 // 2.7 V required for the Numonyx device.
351 | #define VDD_MIN_RUN (VDD_2_0+4) // VDD_MIN_RUN = VDD_MIN_NV
352 | #define VDD_MIN_NV (VDD_2_0+4) // 5% margin over minimum to survive a page erase and compaction.
353 | #define VDD_MIN_GOOD (VDD_2_0+8) // 10% margin over minimum to survive a page erase and compaction.
354 | #define VDD_MIN_XNV (VDD_2_7+5) // 5% margin over minimum to survive a page erase and compaction.
355 |
356 | /* ------------------------------------------------------------------------------------------------
357 | * Driver Configuration
358 | * ------------------------------------------------------------------------------------------------
359 | */
360 |
361 | /* Set to TRUE enable H/W TIMER usage, FALSE disable it */
362 | #ifndef HAL_TIMER
363 | #define HAL_TIMER FALSE
364 | #endif
365 |
366 | /* Set to TRUE enable ADC usage, FALSE disable it */
367 | #ifndef HAL_ADC
368 | #define HAL_ADC TRUE
369 | #endif
370 |
371 | /* Set to TRUE enable DMA usage, FALSE disable it */
372 | #ifndef HAL_DMA
373 | #define HAL_DMA TRUE
374 | #endif
375 |
376 | /* Set to TRUE enable Flash access, FALSE disable it */
377 | #ifndef HAL_FLASH
378 | #define HAL_FLASH TRUE
379 | #endif
380 |
381 | /* Set to TRUE enable AES usage, FALSE disable it */
382 | #ifndef HAL_AES
383 | #define HAL_AES TRUE
384 | #endif
385 |
386 | #ifndef HAL_AES_DMA
387 | #define HAL_AES_DMA TRUE
388 | #endif
389 |
390 | /* Set to TRUE enable LCD usage, FALSE disable it */
391 | #ifndef HAL_LCD
392 | #define HAL_LCD TRUE
393 | #endif
394 |
395 | /* Set to TRUE enable LED usage, FALSE disable it */
396 | #ifndef HAL_LED
397 | #define HAL_LED TRUE
398 | #endif
399 | #if (!defined BLINK_LEDS) && (HAL_LED == TRUE)
400 | #define BLINK_LEDS
401 | #endif
402 |
403 | /* Set to TRUE enable KEY usage, FALSE disable it */
404 | #ifndef HAL_KEY
405 | #define HAL_KEY TRUE
406 | #endif
407 |
408 | /* Set to TRUE enable UART usage, FALSE disable it */
409 | #ifndef HAL_UART
410 | #if (defined ZAPP_P1) || (defined ZAPP_P2) || (defined ZTOOL_P1) || (defined ZTOOL_P2)
411 | #define HAL_UART TRUE
412 | #else
413 | #define HAL_UART FALSE
414 | #endif
415 | #endif
416 |
417 | #if HAL_UART
418 | #ifndef HAL_UART_DMA
419 | #if HAL_DMA
420 | #if (defined ZAPP_P2) || (defined ZTOOL_P2)
421 | #define HAL_UART_DMA 2
422 | #else
423 | #define HAL_UART_DMA 1
424 | #endif
425 | #else
426 | #define HAL_UART_DMA 0
427 | #endif
428 | #endif
429 |
430 | #ifndef HAL_UART_ISR
431 | #if HAL_UART_DMA // Default preference for DMA over ISR.
432 | #define HAL_UART_ISR 0
433 | #elif (defined ZAPP_P2) || (defined ZTOOL_P2)
434 | #define HAL_UART_ISR 2
435 | #else
436 | #define HAL_UART_ISR 1
437 | #endif
438 | #endif
439 |
440 | #if (HAL_UART_DMA && (HAL_UART_DMA == HAL_UART_ISR))
441 | #error HAL_UART_DMA & HAL_UART_ISR must be different.
442 | #endif
443 |
444 | // Used to set P2 priority - USART0 over USART1 if both are defined.
445 | #if ((HAL_UART_DMA == 1) || (HAL_UART_ISR == 1))
446 | #define HAL_UART_PRIPO 0x00
447 | #else
448 | #define HAL_UART_PRIPO 0x40
449 | #endif
450 |
451 | #else
452 | #define HAL_UART_DMA 0
453 | #define HAL_UART_ISR 0
454 | #endif
455 |
456 | /* USB is not used for CC2530 configuration */
457 | #define HAL_UART_USB 0
458 | #endif
459 | /*******************************************************************************************************
460 | */
461 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | GNU GENERAL PUBLIC LICENSE
2 | Version 3, 29 June 2007
3 |
4 | Copyright (C) 2007 Free Software Foundation, Inc.
5 | Everyone is permitted to copy and distribute verbatim copies
6 | of this license document, but changing it is not allowed.
7 |
8 | Preamble
9 |
10 | The GNU General Public License is a free, copyleft license for
11 | software and other kinds of works.
12 |
13 | The licenses for most software and other practical works are designed
14 | to take away your freedom to share and change the works. By contrast,
15 | the GNU General Public License is intended to guarantee your freedom to
16 | share and change all versions of a program--to make sure it remains free
17 | software for all its users. We, the Free Software Foundation, use the
18 | GNU General Public License for most of our software; it applies also to
19 | any other work released this way by its authors. You can apply it to
20 | your programs, too.
21 |
22 | When we speak of free software, we are referring to freedom, not
23 | price. Our General Public Licenses are designed to make sure that you
24 | have the freedom to distribute copies of free software (and charge for
25 | them if you wish), that you receive source code or can get it if you
26 | want it, that you can change the software or use pieces of it in new
27 | free programs, and that you know you can do these things.
28 |
29 | To protect your rights, we need to prevent others from denying you
30 | these rights or asking you to surrender the rights. Therefore, you have
31 | certain responsibilities if you distribute copies of the software, or if
32 | you modify it: responsibilities to respect the freedom of others.
33 |
34 | For example, if you distribute copies of such a program, whether
35 | gratis or for a fee, you must pass on to the recipients the same
36 | freedoms that you received. You must make sure that they, too, receive
37 | or can get the source code. And you must show them these terms so they
38 | know their rights.
39 |
40 | Developers that use the GNU GPL protect your rights with two steps:
41 | (1) assert copyright on the software, and (2) offer you this License
42 | giving you legal permission to copy, distribute and/or modify it.
43 |
44 | For the developers' and authors' protection, the GPL clearly explains
45 | that there is no warranty for this free software. For both users' and
46 | authors' sake, the GPL requires that modified versions be marked as
47 | changed, so that their problems will not be attributed erroneously to
48 | authors of previous versions.
49 |
50 | Some devices are designed to deny users access to install or run
51 | modified versions of the software inside them, although the manufacturer
52 | can do so. This is fundamentally incompatible with the aim of
53 | protecting users' freedom to change the software. The systematic
54 | pattern of such abuse occurs in the area of products for individuals to
55 | use, which is precisely where it is most unacceptable. Therefore, we
56 | have designed this version of the GPL to prohibit the practice for those
57 | products. If such problems arise substantially in other domains, we
58 | stand ready to extend this provision to those domains in future versions
59 | of the GPL, as needed to protect the freedom of users.
60 |
61 | Finally, every program is threatened constantly by software patents.
62 | States should not allow patents to restrict development and use of
63 | software on general-purpose computers, but in those that do, we wish to
64 | avoid the special danger that patents applied to a free program could
65 | make it effectively proprietary. To prevent this, the GPL assures that
66 | patents cannot be used to render the program non-free.
67 |
68 | The precise terms and conditions for copying, distribution and
69 | modification follow.
70 |
71 | TERMS AND CONDITIONS
72 |
73 | 0. Definitions.
74 |
75 | "This License" refers to version 3 of the GNU General Public License.
76 |
77 | "Copyright" also means copyright-like laws that apply to other kinds of
78 | works, such as semiconductor masks.
79 |
80 | "The Program" refers to any copyrightable work licensed under this
81 | License. Each licensee is addressed as "you". "Licensees" and
82 | "recipients" may be individuals or organizations.
83 |
84 | To "modify" a work means to copy from or adapt all or part of the work
85 | in a fashion requiring copyright permission, other than the making of an
86 | exact copy. The resulting work is called a "modified version" of the
87 | earlier work or a work "based on" the earlier work.
88 |
89 | A "covered work" means either the unmodified Program or a work based
90 | on the Program.
91 |
92 | To "propagate" a work means to do anything with it that, without
93 | permission, would make you directly or secondarily liable for
94 | infringement under applicable copyright law, except executing it on a
95 | computer or modifying a private copy. Propagation includes copying,
96 | distribution (with or without modification), making available to the
97 | public, and in some countries other activities as well.
98 |
99 | To "convey" a work means any kind of propagation that enables other
100 | parties to make or receive copies. Mere interaction with a user through
101 | a computer network, with no transfer of a copy, is not conveying.
102 |
103 | An interactive user interface displays "Appropriate Legal Notices"
104 | to the extent that it includes a convenient and prominently visible
105 | feature that (1) displays an appropriate copyright notice, and (2)
106 | tells the user that there is no warranty for the work (except to the
107 | extent that warranties are provided), that licensees may convey the
108 | work under this License, and how to view a copy of this License. If
109 | the interface presents a list of user commands or options, such as a
110 | menu, a prominent item in the list meets this criterion.
111 |
112 | 1. Source Code.
113 |
114 | The "source code" for a work means the preferred form of the work
115 | for making modifications to it. "Object code" means any non-source
116 | form of a work.
117 |
118 | A "Standard Interface" means an interface that either is an official
119 | standard defined by a recognized standards body, or, in the case of
120 | interfaces specified for a particular programming language, one that
121 | is widely used among developers working in that language.
122 |
123 | The "System Libraries" of an executable work include anything, other
124 | than the work as a whole, that (a) is included in the normal form of
125 | packaging a Major Component, but which is not part of that Major
126 | Component, and (b) serves only to enable use of the work with that
127 | Major Component, or to implement a Standard Interface for which an
128 | implementation is available to the public in source code form. A
129 | "Major Component", in this context, means a major essential component
130 | (kernel, window system, and so on) of the specific operating system
131 | (if any) on which the executable work runs, or a compiler used to
132 | produce the work, or an object code interpreter used to run it.
133 |
134 | The "Corresponding Source" for a work in object code form means all
135 | the source code needed to generate, install, and (for an executable
136 | work) run the object code and to modify the work, including scripts to
137 | control those activities. However, it does not include the work's
138 | System Libraries, or general-purpose tools or generally available free
139 | programs which are used unmodified in performing those activities but
140 | which are not part of the work. For example, Corresponding Source
141 | includes interface definition files associated with source files for
142 | the work, and the source code for shared libraries and dynamically
143 | linked subprograms that the work is specifically designed to require,
144 | such as by intimate data communication or control flow between those
145 | subprograms and other parts of the work.
146 |
147 | The Corresponding Source need not include anything that users
148 | can regenerate automatically from other parts of the Corresponding
149 | Source.
150 |
151 | The Corresponding Source for a work in source code form is that
152 | same work.
153 |
154 | 2. Basic Permissions.
155 |
156 | All rights granted under this License are granted for the term of
157 | copyright on the Program, and are irrevocable provided the stated
158 | conditions are met. This License explicitly affirms your unlimited
159 | permission to run the unmodified Program. The output from running a
160 | covered work is covered by this License only if the output, given its
161 | content, constitutes a covered work. This License acknowledges your
162 | rights of fair use or other equivalent, as provided by copyright law.
163 |
164 | You may make, run and propagate covered works that you do not
165 | convey, without conditions so long as your license otherwise remains
166 | in force. You may convey covered works to others for the sole purpose
167 | of having them make modifications exclusively for you, or provide you
168 | with facilities for running those works, provided that you comply with
169 | the terms of this License in conveying all material for which you do
170 | not control copyright. Those thus making or running the covered works
171 | for you must do so exclusively on your behalf, under your direction
172 | and control, on terms that prohibit them from making any copies of
173 | your copyrighted material outside their relationship with you.
174 |
175 | Conveying under any other circumstances is permitted solely under
176 | the conditions stated below. Sublicensing is not allowed; section 10
177 | makes it unnecessary.
178 |
179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180 |
181 | No covered work shall be deemed part of an effective technological
182 | measure under any applicable law fulfilling obligations under article
183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184 | similar laws prohibiting or restricting circumvention of such
185 | measures.
186 |
187 | When you convey a covered work, you waive any legal power to forbid
188 | circumvention of technological measures to the extent such circumvention
189 | is effected by exercising rights under this License with respect to
190 | the covered work, and you disclaim any intention to limit operation or
191 | modification of the work as a means of enforcing, against the work's
192 | users, your or third parties' legal rights to forbid circumvention of
193 | technological measures.
194 |
195 | 4. Conveying Verbatim Copies.
196 |
197 | You may convey verbatim copies of the Program's source code as you
198 | receive it, in any medium, provided that you conspicuously and
199 | appropriately publish on each copy an appropriate copyright notice;
200 | keep intact all notices stating that this License and any
201 | non-permissive terms added in accord with section 7 apply to the code;
202 | keep intact all notices of the absence of any warranty; and give all
203 | recipients a copy of this License along with the Program.
204 |
205 | You may charge any price or no price for each copy that you convey,
206 | and you may offer support or warranty protection for a fee.
207 |
208 | 5. Conveying Modified Source Versions.
209 |
210 | You may convey a work based on the Program, or the modifications to
211 | produce it from the Program, in the form of source code under the
212 | terms of section 4, provided that you also meet all of these conditions:
213 |
214 | a) The work must carry prominent notices stating that you modified
215 | it, and giving a relevant date.
216 |
217 | b) The work must carry prominent notices stating that it is
218 | released under this License and any conditions added under section
219 | 7. This requirement modifies the requirement in section 4 to
220 | "keep intact all notices".
221 |
222 | c) You must license the entire work, as a whole, under this
223 | License to anyone who comes into possession of a copy. This
224 | License will therefore apply, along with any applicable section 7
225 | additional terms, to the whole of the work, and all its parts,
226 | regardless of how they are packaged. This License gives no
227 | permission to license the work in any other way, but it does not
228 | invalidate such permission if you have separately received it.
229 |
230 | d) If the work has interactive user interfaces, each must display
231 | Appropriate Legal Notices; however, if the Program has interactive
232 | interfaces that do not display Appropriate Legal Notices, your
233 | work need not make them do so.
234 |
235 | A compilation of a covered work with other separate and independent
236 | works, which are not by their nature extensions of the covered work,
237 | and which are not combined with it such as to form a larger program,
238 | in or on a volume of a storage or distribution medium, is called an
239 | "aggregate" if the compilation and its resulting copyright are not
240 | used to limit the access or legal rights of the compilation's users
241 | beyond what the individual works permit. Inclusion of a covered work
242 | in an aggregate does not cause this License to apply to the other
243 | parts of the aggregate.
244 |
245 | 6. Conveying Non-Source Forms.
246 |
247 | You may convey a covered work in object code form under the terms
248 | of sections 4 and 5, provided that you also convey the
249 | machine-readable Corresponding Source under the terms of this License,
250 | in one of these ways:
251 |
252 | a) Convey the object code in, or embodied in, a physical product
253 | (including a physical distribution medium), accompanied by the
254 | Corresponding Source fixed on a durable physical medium
255 | customarily used for software interchange.
256 |
257 | b) Convey the object code in, or embodied in, a physical product
258 | (including a physical distribution medium), accompanied by a
259 | written offer, valid for at least three years and valid for as
260 | long as you offer spare parts or customer support for that product
261 | model, to give anyone who possesses the object code either (1) a
262 | copy of the Corresponding Source for all the software in the
263 | product that is covered by this License, on a durable physical
264 | medium customarily used for software interchange, for a price no
265 | more than your reasonable cost of physically performing this
266 | conveying of source, or (2) access to copy the
267 | Corresponding Source from a network server at no charge.
268 |
269 | c) Convey individual copies of the object code with a copy of the
270 | written offer to provide the Corresponding Source. This
271 | alternative is allowed only occasionally and noncommercially, and
272 | only if you received the object code with such an offer, in accord
273 | with subsection 6b.
274 |
275 | d) Convey the object code by offering access from a designated
276 | place (gratis or for a charge), and offer equivalent access to the
277 | Corresponding Source in the same way through the same place at no
278 | further charge. You need not require recipients to copy the
279 | Corresponding Source along with the object code. If the place to
280 | copy the object code is a network server, the Corresponding Source
281 | may be on a different server (operated by you or a third party)
282 | that supports equivalent copying facilities, provided you maintain
283 | clear directions next to the object code saying where to find the
284 | Corresponding Source. Regardless of what server hosts the
285 | Corresponding Source, you remain obligated to ensure that it is
286 | available for as long as needed to satisfy these requirements.
287 |
288 | e) Convey the object code using peer-to-peer transmission, provided
289 | you inform other peers where the object code and Corresponding
290 | Source of the work are being offered to the general public at no
291 | charge under subsection 6d.
292 |
293 | A separable portion of the object code, whose source code is excluded
294 | from the Corresponding Source as a System Library, need not be
295 | included in conveying the object code work.
296 |
297 | A "User Product" is either (1) a "consumer product", which means any
298 | tangible personal property which is normally used for personal, family,
299 | or household purposes, or (2) anything designed or sold for incorporation
300 | into a dwelling. In determining whether a product is a consumer product,
301 | doubtful cases shall be resolved in favor of coverage. For a particular
302 | product received by a particular user, "normally used" refers to a
303 | typical or common use of that class of product, regardless of the status
304 | of the particular user or of the way in which the particular user
305 | actually uses, or expects or is expected to use, the product. A product
306 | is a consumer product regardless of whether the product has substantial
307 | commercial, industrial or non-consumer uses, unless such uses represent
308 | the only significant mode of use of the product.
309 |
310 | "Installation Information" for a User Product means any methods,
311 | procedures, authorization keys, or other information required to install
312 | and execute modified versions of a covered work in that User Product from
313 | a modified version of its Corresponding Source. The information must
314 | suffice to ensure that the continued functioning of the modified object
315 | code is in no case prevented or interfered with solely because
316 | modification has been made.
317 |
318 | If you convey an object code work under this section in, or with, or
319 | specifically for use in, a User Product, and the conveying occurs as
320 | part of a transaction in which the right of possession and use of the
321 | User Product is transferred to the recipient in perpetuity or for a
322 | fixed term (regardless of how the transaction is characterized), the
323 | Corresponding Source conveyed under this section must be accompanied
324 | by the Installation Information. But this requirement does not apply
325 | if neither you nor any third party retains the ability to install
326 | modified object code on the User Product (for example, the work has
327 | been installed in ROM).
328 |
329 | The requirement to provide Installation Information does not include a
330 | requirement to continue to provide support service, warranty, or updates
331 | for a work that has been modified or installed by the recipient, or for
332 | the User Product in which it has been modified or installed. Access to a
333 | network may be denied when the modification itself materially and
334 | adversely affects the operation of the network or violates the rules and
335 | protocols for communication across the network.
336 |
337 | Corresponding Source conveyed, and Installation Information provided,
338 | in accord with this section must be in a format that is publicly
339 | documented (and with an implementation available to the public in
340 | source code form), and must require no special password or key for
341 | unpacking, reading or copying.
342 |
343 | 7. Additional Terms.
344 |
345 | "Additional permissions" are terms that supplement the terms of this
346 | License by making exceptions from one or more of its conditions.
347 | Additional permissions that are applicable to the entire Program shall
348 | be treated as though they were included in this License, to the extent
349 | that they are valid under applicable law. If additional permissions
350 | apply only to part of the Program, that part may be used separately
351 | under those permissions, but the entire Program remains governed by
352 | this License without regard to the additional permissions.
353 |
354 | When you convey a copy of a covered work, you may at your option
355 | remove any additional permissions from that copy, or from any part of
356 | it. (Additional permissions may be written to require their own
357 | removal in certain cases when you modify the work.) You may place
358 | additional permissions on material, added by you to a covered work,
359 | for which you have or can give appropriate copyright permission.
360 |
361 | Notwithstanding any other provision of this License, for material you
362 | add to a covered work, you may (if authorized by the copyright holders of
363 | that material) supplement the terms of this License with terms:
364 |
365 | a) Disclaiming warranty or limiting liability differently from the
366 | terms of sections 15 and 16 of this License; or
367 |
368 | b) Requiring preservation of specified reasonable legal notices or
369 | author attributions in that material or in the Appropriate Legal
370 | Notices displayed by works containing it; or
371 |
372 | c) Prohibiting misrepresentation of the origin of that material, or
373 | requiring that modified versions of such material be marked in
374 | reasonable ways as different from the original version; or
375 |
376 | d) Limiting the use for publicity purposes of names of licensors or
377 | authors of the material; or
378 |
379 | e) Declining to grant rights under trademark law for use of some
380 | trade names, trademarks, or service marks; or
381 |
382 | f) Requiring indemnification of licensors and authors of that
383 | material by anyone who conveys the material (or modified versions of
384 | it) with contractual assumptions of liability to the recipient, for
385 | any liability that these contractual assumptions directly impose on
386 | those licensors and authors.
387 |
388 | All other non-permissive additional terms are considered "further
389 | restrictions" within the meaning of section 10. If the Program as you
390 | received it, or any part of it, contains a notice stating that it is
391 | governed by this License along with a term that is a further
392 | restriction, you may remove that term. If a license document contains
393 | a further restriction but permits relicensing or conveying under this
394 | License, you may add to a covered work material governed by the terms
395 | of that license document, provided that the further restriction does
396 | not survive such relicensing or conveying.
397 |
398 | If you add terms to a covered work in accord with this section, you
399 | must place, in the relevant source files, a statement of the
400 | additional terms that apply to those files, or a notice indicating
401 | where to find the applicable terms.
402 |
403 | Additional terms, permissive or non-permissive, may be stated in the
404 | form of a separately written license, or stated as exceptions;
405 | the above requirements apply either way.
406 |
407 | 8. Termination.
408 |
409 | You may not propagate or modify a covered work except as expressly
410 | provided under this License. Any attempt otherwise to propagate or
411 | modify it is void, and will automatically terminate your rights under
412 | this License (including any patent licenses granted under the third
413 | paragraph of section 11).
414 |
415 | However, if you cease all violation of this License, then your
416 | license from a particular copyright holder is reinstated (a)
417 | provisionally, unless and until the copyright holder explicitly and
418 | finally terminates your license, and (b) permanently, if the copyright
419 | holder fails to notify you of the violation by some reasonable means
420 | prior to 60 days after the cessation.
421 |
422 | Moreover, your license from a particular copyright holder is
423 | reinstated permanently if the copyright holder notifies you of the
424 | violation by some reasonable means, this is the first time you have
425 | received notice of violation of this License (for any work) from that
426 | copyright holder, and you cure the violation prior to 30 days after
427 | your receipt of the notice.
428 |
429 | Termination of your rights under this section does not terminate the
430 | licenses of parties who have received copies or rights from you under
431 | this License. If your rights have been terminated and not permanently
432 | reinstated, you do not qualify to receive new licenses for the same
433 | material under section 10.
434 |
435 | 9. Acceptance Not Required for Having Copies.
436 |
437 | You are not required to accept this License in order to receive or
438 | run a copy of the Program. Ancillary propagation of a covered work
439 | occurring solely as a consequence of using peer-to-peer transmission
440 | to receive a copy likewise does not require acceptance. However,
441 | nothing other than this License grants you permission to propagate or
442 | modify any covered work. These actions infringe copyright if you do
443 | not accept this License. Therefore, by modifying or propagating a
444 | covered work, you indicate your acceptance of this License to do so.
445 |
446 | 10. Automatic Licensing of Downstream Recipients.
447 |
448 | Each time you convey a covered work, the recipient automatically
449 | receives a license from the original licensors, to run, modify and
450 | propagate that work, subject to this License. You are not responsible
451 | for enforcing compliance by third parties with this License.
452 |
453 | An "entity transaction" is a transaction transferring control of an
454 | organization, or substantially all assets of one, or subdividing an
455 | organization, or merging organizations. If propagation of a covered
456 | work results from an entity transaction, each party to that
457 | transaction who receives a copy of the work also receives whatever
458 | licenses to the work the party's predecessor in interest had or could
459 | give under the previous paragraph, plus a right to possession of the
460 | Corresponding Source of the work from the predecessor in interest, if
461 | the predecessor has it or can get it with reasonable efforts.
462 |
463 | You may not impose any further restrictions on the exercise of the
464 | rights granted or affirmed under this License. For example, you may
465 | not impose a license fee, royalty, or other charge for exercise of
466 | rights granted under this License, and you may not initiate litigation
467 | (including a cross-claim or counterclaim in a lawsuit) alleging that
468 | any patent claim is infringed by making, using, selling, offering for
469 | sale, or importing the Program or any portion of it.
470 |
471 | 11. Patents.
472 |
473 | A "contributor" is a copyright holder who authorizes use under this
474 | License of the Program or a work on which the Program is based. The
475 | work thus licensed is called the contributor's "contributor version".
476 |
477 | A contributor's "essential patent claims" are all patent claims
478 | owned or controlled by the contributor, whether already acquired or
479 | hereafter acquired, that would be infringed by some manner, permitted
480 | by this License, of making, using, or selling its contributor version,
481 | but do not include claims that would be infringed only as a
482 | consequence of further modification of the contributor version. For
483 | purposes of this definition, "control" includes the right to grant
484 | patent sublicenses in a manner consistent with the requirements of
485 | this License.
486 |
487 | Each contributor grants you a non-exclusive, worldwide, royalty-free
488 | patent license under the contributor's essential patent claims, to
489 | make, use, sell, offer for sale, import and otherwise run, modify and
490 | propagate the contents of its contributor version.
491 |
492 | In the following three paragraphs, a "patent license" is any express
493 | agreement or commitment, however denominated, not to enforce a patent
494 | (such as an express permission to practice a patent or covenant not to
495 | sue for patent infringement). To "grant" such a patent license to a
496 | party means to make such an agreement or commitment not to enforce a
497 | patent against the party.
498 |
499 | If you convey a covered work, knowingly relying on a patent license,
500 | and the Corresponding Source of the work is not available for anyone
501 | to copy, free of charge and under the terms of this License, through a
502 | publicly available network server or other readily accessible means,
503 | then you must either (1) cause the Corresponding Source to be so
504 | available, or (2) arrange to deprive yourself of the benefit of the
505 | patent license for this particular work, or (3) arrange, in a manner
506 | consistent with the requirements of this License, to extend the patent
507 | license to downstream recipients. "Knowingly relying" means you have
508 | actual knowledge that, but for the patent license, your conveying the
509 | covered work in a country, or your recipient's use of the covered work
510 | in a country, would infringe one or more identifiable patents in that
511 | country that you have reason to believe are valid.
512 |
513 | If, pursuant to or in connection with a single transaction or
514 | arrangement, you convey, or propagate by procuring conveyance of, a
515 | covered work, and grant a patent license to some of the parties
516 | receiving the covered work authorizing them to use, propagate, modify
517 | or convey a specific copy of the covered work, then the patent license
518 | you grant is automatically extended to all recipients of the covered
519 | work and works based on it.
520 |
521 | A patent license is "discriminatory" if it does not include within
522 | the scope of its coverage, prohibits the exercise of, or is
523 | conditioned on the non-exercise of one or more of the rights that are
524 | specifically granted under this License. You may not convey a covered
525 | work if you are a party to an arrangement with a third party that is
526 | in the business of distributing software, under which you make payment
527 | to the third party based on the extent of your activity of conveying
528 | the work, and under which the third party grants, to any of the
529 | parties who would receive the covered work from you, a discriminatory
530 | patent license (a) in connection with copies of the covered work
531 | conveyed by you (or copies made from those copies), or (b) primarily
532 | for and in connection with specific products or compilations that
533 | contain the covered work, unless you entered into that arrangement,
534 | or that patent license was granted, prior to 28 March 2007.
535 |
536 | Nothing in this License shall be construed as excluding or limiting
537 | any implied license or other defenses to infringement that may
538 | otherwise be available to you under applicable patent law.
539 |
540 | 12. No Surrender of Others' Freedom.
541 |
542 | If conditions are imposed on you (whether by court order, agreement or
543 | otherwise) that contradict the conditions of this License, they do not
544 | excuse you from the conditions of this License. If you cannot convey a
545 | covered work so as to satisfy simultaneously your obligations under this
546 | License and any other pertinent obligations, then as a consequence you may
547 | not convey it at all. For example, if you agree to terms that obligate you
548 | to collect a royalty for further conveying from those to whom you convey
549 | the Program, the only way you could satisfy both those terms and this
550 | License would be to refrain entirely from conveying the Program.
551 |
552 | 13. Use with the GNU Affero General Public License.
553 |
554 | Notwithstanding any other provision of this License, you have
555 | permission to link or combine any covered work with a work licensed
556 | under version 3 of the GNU Affero General Public License into a single
557 | combined work, and to convey the resulting work. The terms of this
558 | License will continue to apply to the part which is the covered work,
559 | but the special requirements of the GNU Affero General Public License,
560 | section 13, concerning interaction through a network will apply to the
561 | combination as such.
562 |
563 | 14. Revised Versions of this License.
564 |
565 | The Free Software Foundation may publish revised and/or new versions of
566 | the GNU General Public License from time to time. Such new versions will
567 | be similar in spirit to the present version, but may differ in detail to
568 | address new problems or concerns.
569 |
570 | Each version is given a distinguishing version number. If the
571 | Program specifies that a certain numbered version of the GNU General
572 | Public License "or any later version" applies to it, you have the
573 | option of following the terms and conditions either of that numbered
574 | version or of any later version published by the Free Software
575 | Foundation. If the Program does not specify a version number of the
576 | GNU General Public License, you may choose any version ever published
577 | by the Free Software Foundation.
578 |
579 | If the Program specifies that a proxy can decide which future
580 | versions of the GNU General Public License can be used, that proxy's
581 | public statement of acceptance of a version permanently authorizes you
582 | to choose that version for the Program.
583 |
584 | Later license versions may give you additional or different
585 | permissions. However, no additional obligations are imposed on any
586 | author or copyright holder as a result of your choosing to follow a
587 | later version.
588 |
589 | 15. Disclaimer of Warranty.
590 |
591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599 |
600 | 16. Limitation of Liability.
601 |
602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610 | SUCH DAMAGES.
611 |
612 | 17. Interpretation of Sections 15 and 16.
613 |
614 | If the disclaimer of warranty and limitation of liability provided
615 | above cannot be given local legal effect according to their terms,
616 | reviewing courts shall apply local law that most closely approximates
617 | an absolute waiver of all civil liability in connection with the
618 | Program, unless a warranty or assumption of liability accompanies a
619 | copy of the Program in return for a fee.
620 |
621 | END OF TERMS AND CONDITIONS
622 |
623 | How to Apply These Terms to Your New Programs
624 |
625 | If you develop a new program, and you want it to be of the greatest
626 | possible use to the public, the best way to achieve this is to make it
627 | free software which everyone can redistribute and change under these terms.
628 |
629 | To do so, attach the following notices to the program. It is safest
630 | to attach them to the start of each source file to most effectively
631 | state the exclusion of warranty; and each file should have at least
632 | the "copyright" line and a pointer to where the full notice is found.
633 |
634 |
635 | Copyright (C)
636 |
637 | This program is free software: you can redistribute it and/or modify
638 | it under the terms of the GNU General Public License as published by
639 | the Free Software Foundation, either version 3 of the License, or
640 | (at your option) any later version.
641 |
642 | This program is distributed in the hope that it will be useful,
643 | but WITHOUT ANY WARRANTY; without even the implied warranty of
644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
645 | GNU General Public License for more details.
646 |
647 | You should have received a copy of the GNU General Public License
648 | along with this program. If not, see .
649 |
650 | Also add information on how to contact you by electronic and paper mail.
651 |
652 | If the program does terminal interaction, make it output a short
653 | notice like this when it starts in an interactive mode:
654 |
655 | Copyright (C)
656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 | This is free software, and you are welcome to redistribute it
658 | under certain conditions; type `show c' for details.
659 |
660 | The hypothetical commands `show w' and `show c' should show the appropriate
661 | parts of the General Public License. Of course, your program's commands
662 | might be different; for a GUI interface, you would use an "about box".
663 |
664 | You should also get your employer (if you work as a programmer) or school,
665 | if any, to sign a "copyright disclaimer" for the program, if necessary.
666 | For more information on this, and how to apply and follow the GNU GPL, see
667 | .
668 |
669 | The GNU General Public License does not permit incorporating your program
670 | into proprietary programs. If your program is a subroutine library, you
671 | may consider it more useful to permit linking proprietary applications with
672 | the library. If this is what you want to do, use the GNU Lesser General
673 | Public License instead of this License. But first, please read
674 | .
675 |
--------------------------------------------------------------------------------