Mercurial > ~darius > hgwebdir.cgi > tempctrl

annotate 1wire.h @ 77:ca5fc59ec4f0

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Change default temperature to 18C - better for Ale yeast.
author darius@Inchoate
date Wed, 21 Jan 2009 22:51:59 +1030
parents 4abce5954d25
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
8
f9a085a0ba93 Change the 1 wire routines to mostly C with assembly delay routines
darius
parents: 0
diff changeset
1 /*
32
b0cb873c0206 Isolate the bus frobbing parts and the delays into a separate header.
darius
parents: 24
diff changeset
2 * 1 wire header which defines functions and constants
8
f9a085a0ba93 Change the 1 wire routines to mostly C with assembly delay routines
darius
parents: 0
diff changeset
3 *
f9a085a0ba93 Change the 1 wire routines to mostly C with assembly delay routines
darius
parents: 0
diff changeset
4 * $Id$
f9a085a0ba93 Change the 1 wire routines to mostly C with assembly delay routines
darius
parents: 0
diff changeset
5 *
f9a085a0ba93 Change the 1 wire routines to mostly C with assembly delay routines
darius
parents: 0
diff changeset
6 * Copyright (c) 2004
0
ffeab3c04e83 Initial revision
darius
parents:
diff changeset
7 * Daniel O'Connor <darius@dons.net.au>. All rights reserved.
ffeab3c04e83 Initial revision
darius
parents:
diff changeset
8 *
ffeab3c04e83 Initial revision
darius
parents:
diff changeset
9 * Redistribution and use in source and binary forms, with or without
ffeab3c04e83 Initial revision
darius
parents:
diff changeset
10 * modification, are permitted provided that the following conditions
ffeab3c04e83 Initial revision
darius
parents:
diff changeset
11 * are met:
ffeab3c04e83 Initial revision
darius
parents:
diff changeset
12 * 1. Redistributions of source code must retain the above copyright
ffeab3c04e83 Initial revision
darius
parents:
diff changeset
13 * notice, this list of conditions and the following disclaimer.
ffeab3c04e83 Initial revision
darius
parents:
diff changeset
14 * 2. Redistributions in binary form must reproduce the above copyright
ffeab3c04e83 Initial revision
darius
parents:
diff changeset
15 * notice, this list of conditions and the following disclaimer in the
ffeab3c04e83 Initial revision
darius
parents:
diff changeset
16 * documentation and/or other materials provided with the distribution.
ffeab3c04e83 Initial revision
darius
parents:
diff changeset
17 *
ffeab3c04e83 Initial revision
darius
parents:
diff changeset
18 * THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS ``AS IS'' AND
ffeab3c04e83 Initial revision
darius
parents:
diff changeset
19 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
ffeab3c04e83 Initial revision
darius
parents:
diff changeset
20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ffeab3c04e83 Initial revision
darius
parents:
diff changeset
21 * ARE DISCLAIMED. IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
ffeab3c04e83 Initial revision
darius
parents:
diff changeset
22 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
ffeab3c04e83 Initial revision
darius
parents:
diff changeset
23 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
ffeab3c04e83 Initial revision
darius
parents:
diff changeset
24 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
ffeab3c04e83 Initial revision
darius
parents:
diff changeset
25 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
ffeab3c04e83 Initial revision
darius
parents:
diff changeset
26 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
ffeab3c04e83 Initial revision
darius
parents:
diff changeset
27 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
ffeab3c04e83 Initial revision
darius
parents:
diff changeset
28 * SUCH DAMAGE.
ffeab3c04e83 Initial revision
darius
parents:
diff changeset
29 */
ffeab3c04e83 Initial revision
darius
parents:
diff changeset
30
32
b0cb873c0206 Isolate the bus frobbing parts and the delays into a separate header.
darius
parents: 24
diff changeset
31 void OWInit(void);
12
4b141cc7cbd4 - Reduce type widths where possible.
darius
parents: 10
diff changeset
32 uint8_t OWTouchReset(void);
4b141cc7cbd4 - Reduce type widths where possible.
darius
parents: 10
diff changeset
33 void OWWriteBit(uint8_t bit);
4b141cc7cbd4 - Reduce type widths where possible.
darius
parents: 10
diff changeset
34 uint8_t OWReadBit(void);
0
ffeab3c04e83 Initial revision
darius
parents:
diff changeset
35 void OWWriteByte(uint8_t data);
12
4b141cc7cbd4 - Reduce type widths where possible.
darius
parents: 10
diff changeset
36 uint8_t OWReadByte(void);
4b141cc7cbd4 - Reduce type widths where possible.
darius
parents: 10
diff changeset
37 uint8_t OWTouchByte(uint8_t data);
0
ffeab3c04e83 Initial revision
darius
parents:
diff changeset
38 void OWBlock(uint8_t *data, int len);
12
4b141cc7cbd4 - Reduce type widths where possible.
darius
parents: 10
diff changeset
39 uint8_t OWFirst(uint8_t *ROM, uint8_t do_reset, uint8_t alarm_only);
4b141cc7cbd4 - Reduce type widths where possible.
darius
parents: 10
diff changeset
40 uint8_t OWNext(uint8_t *ROM, uint8_t do_reset, uint8_t alarm_only);
0
ffeab3c04e83 Initial revision
darius
parents:
diff changeset
41 void OWCRC(uint8_t x, uint8_t *crc);
ffeab3c04e83 Initial revision
darius
parents:
diff changeset
42 void OWSendCmd(uint8_t *ROM, uint8_t cmd);
33
0aa6bf4b98ae - Don't wrap individual debug statements in ifdef, use a conditionally
darius
parents: 32
diff changeset
43 uint8_t OWProgROM(uint8_t *ROM, uint8_t start, uint8_t len, uint8_t *data, uint8_t exact, uint8_t status);
41
5898fba6593c Add temperature control.
darius@inchoate.localdomain
parents: 33
diff changeset
44 int16_t OWGetTemp(uint8_t *ROM);
76
4abce5954d25 Add a routine to return text versions of errors from the temperature
darius@Inchoate
parents: 75
diff changeset
45 const PROGMEM char *OWTempStatusStr(int16_t val, uint8_t shrt);
48
94f71ddb0cda Move declaration of error table up with the function declarations.
darius@Inchoate
parents: 45
diff changeset
46 extern const PROGMEM char *OWProgROM_Status[];
94f71ddb0cda Move declaration of error table up with the function declarations.
darius@Inchoate
parents: 45
diff changeset
47
0
ffeab3c04e83 Initial revision
darius
parents:
diff changeset
48
10
eb1faf51968e - Add some useful return values to search functions.
darius
parents: 8
diff changeset
49 /* Return codes for OWFirst()/OWNext() */
eb1faf51968e - Add some useful return values to search functions.
darius
parents: 8
diff changeset
50 #define OW_BADWIRE -3
eb1faf51968e - Add some useful return values to search functions.
darius
parents: 8
diff changeset
51 #define OW_BADCRC -2
eb1faf51968e - Add some useful return values to search functions.
darius
parents: 8
diff changeset
52 #define OW_NOPRESENCE -1
eb1faf51968e - Add some useful return values to search functions.
darius
parents: 8
diff changeset
53 #define OW_NOMODULES 0
eb1faf51968e - Add some useful return values to search functions.
darius
parents: 8
diff changeset
54 #define OW_FOUND 1
eb1faf51968e - Add some useful return values to search functions.
darius
parents: 8
diff changeset
55
0
ffeab3c04e83 Initial revision
darius
parents:
diff changeset
56 /* General 1 wire commands */
ffeab3c04e83 Initial revision
darius
parents:
diff changeset
57 #define OW_OVRDRV_SKIP_CMD 0x3c
ffeab3c04e83 Initial revision
darius
parents:
diff changeset
58 #define OW_SEARCH_ALRM_CMD 0xec
ffeab3c04e83 Initial revision
darius
parents:
diff changeset
59 #define OW_SEARCH_ROM_CMD 0xf0
ffeab3c04e83 Initial revision
darius
parents:
diff changeset
60 #define OW_READ_ROM_CMD 0x33
ffeab3c04e83 Initial revision
darius
parents:
diff changeset
61 #define OW_MATCH_ROM_CMD 0x55
ffeab3c04e83 Initial revision
darius
parents:
diff changeset
62 #define OW_SKIP_ROM_CMD 0xcc
ffeab3c04e83 Initial revision
darius
parents:
diff changeset
63
ffeab3c04e83 Initial revision
darius
parents:
diff changeset
64 /* DS1820 commands */
ffeab3c04e83 Initial revision
darius
parents:
diff changeset
65 #define OW_CONVERTT_CMD 0x44
ffeab3c04e83 Initial revision
darius
parents:
diff changeset
66 #define OW_RD_SCR_CMD 0xbe
ffeab3c04e83 Initial revision
darius
parents:
diff changeset
67 #define OW_WR_SCR_CMD 0x4e
ffeab3c04e83 Initial revision
darius
parents:
diff changeset
68 #define OW_CPY_SCR_CMD 0x48
ffeab3c04e83 Initial revision
darius
parents:
diff changeset
69 #define OW_RECALL_CMD 0xb8
ffeab3c04e83 Initial revision
darius
parents:
diff changeset
70 #define OW_RD_PSU_CMD 0xb4
ffeab3c04e83 Initial revision
darius
parents:
diff changeset
71
32
b0cb873c0206 Isolate the bus frobbing parts and the delays into a separate header.
darius
parents: 24
diff changeset
72 /* DS2502 commands */
b0cb873c0206 Isolate the bus frobbing parts and the delays into a separate header.
darius
parents: 24
diff changeset
73 #define OW_READ_MEMORY 0xf0
b0cb873c0206 Isolate the bus frobbing parts and the delays into a separate header.
darius
parents: 24
diff changeset
74 #define OW_READ_STATUS 0xaa
b0cb873c0206 Isolate the bus frobbing parts and the delays into a separate header.
darius
parents: 24
diff changeset
75 #define OW_GEN_CRC 0xc3
b0cb873c0206 Isolate the bus frobbing parts and the delays into a separate header.
darius
parents: 24
diff changeset
76 #define OW_WRITE_MEMORY 0x0f
b0cb873c0206 Isolate the bus frobbing parts and the delays into a separate header.
darius
parents: 24
diff changeset
77 #define OW_WRITE_STATUS 0x55
b0cb873c0206 Isolate the bus frobbing parts and the delays into a separate header.
darius
parents: 24
diff changeset
78
0
ffeab3c04e83 Initial revision
darius
parents:
diff changeset
79 /* Family codes */
ffeab3c04e83 Initial revision
darius
parents:
diff changeset
80 #define OW_FAMILY_ROM 0x09
ffeab3c04e83 Initial revision
darius
parents:
diff changeset
81 #define OW_FAMILY_TEMP 0x10
41
5898fba6593c Add temperature control.
darius@inchoate.localdomain
parents: 33
diff changeset
82
5898fba6593c Add temperature control.
darius@inchoate.localdomain
parents: 33
diff changeset
83 /* Return codes for OWGetTemp */
75
39d629c7d935 Change error #define's so that they are outside the range the DS1820 can report.
darius@Inchoate
parents: 65
diff changeset
84 #define OW_TEMP_BADVAL -6000
39d629c7d935 Change error #define's so that they are outside the range the DS1820 can report.
darius@Inchoate
parents: 65
diff changeset
85 #define OW_TEMP_WRONG_FAM -6001
39d629c7d935 Change error #define's so that they are outside the range the DS1820 can report.
darius@Inchoate
parents: 65
diff changeset
86 #define OW_TEMP_CRC_ERR -6002
39d629c7d935 Change error #define's so that they are outside the range the DS1820 can report.
darius@Inchoate
parents: 65
diff changeset
87 #define OW_TEMP_NO_ROM -6003
45
efd44dc40934 Add macros for number system used for temperatures.
darius@Inchoate
parents: 41
diff changeset
88
efd44dc40934 Add macros for number system used for temperatures.
darius@Inchoate
parents: 41
diff changeset
89 /* Helpers for OWGetTemp's number system */
efd44dc40934 Add macros for number system used for temperatures.
darius@Inchoate
parents: 41
diff changeset
90 #define GETWHOLE(x) ((x) / 100)
65
1ef17cd8af7a Tab to space conversion in usage text.
darius@Inchoate
parents: 48
diff changeset
91 #define GETFRAC(x) abs((x) - (GETWHOLE(x) * 100))